Skip to content

Commit bab5805

Browse files
committed
documentation ready
1 parent 1a2382f commit bab5805

File tree

5 files changed

+2
-5
lines changed

5 files changed

+2
-5
lines changed

docs/.nojekyll

Whitespace-only changes.

docs/build/html/_modules/slayer.html

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,6 @@ <h1>Source code for slayer</h1><div class="highlight"><pre>
4545
<div class="viewcode-block" id="yamlParams"><a class="viewcode-back" href="../slayer.html#slayer.yamlParams">[docs]</a><span class="k">class</span> <span class="nc">yamlParams</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
4646
<span class="sd">&#39;&#39;&#39;</span>
4747
<span class="sd"> This class reads yaml parameter file and allows dictionary like access to the members.</span>
48-
<span class="sd"> test</span>
4948
<span class="sd"> </span>
5049
<span class="sd"> Usage:</span>
5150

docs/build/html/searchindex.js

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

docs/build/html/slayer.html

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -203,8 +203,7 @@
203203
<dl class="class">
204204
<dt id="slayer.yamlParams">
205205
<em class="property">class </em><code class="descclassname">slayer.</code><code class="descname">yamlParams</code><span class="sig-paren">(</span><em>parameter_file_path</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/slayer.html#yamlParams"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#slayer.yamlParams" title="Permalink to this definition"></a></dt>
206-
<dd><p>This class reads yaml parameter file and allows dictionary like access to the members.
207-
test</p>
206+
<dd><p>This class reads yaml parameter file and allows dictionary like access to the members.</p>
208207
<p>Usage:</p>
209208
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">import</span> <span class="nn">slayerSNN</span> <span class="kn">as</span> <span class="nn">snn</span>
210209
<span class="n">netParams</span> <span class="o">=</span> <span class="n">snn</span><span class="o">.</span><span class="n">params</span><span class="p">(</span><span class="s1">&#39;path_to_yaml_file&#39;</span><span class="p">)</span> <span class="c1"># OR</span>

src/slayer.py

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,6 @@
1212
class yamlParams(object):
1313
'''
1414
This class reads yaml parameter file and allows dictionary like access to the members.
15-
test
1615
1716
Usage:
1817

0 commit comments

Comments
 (0)