Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
actions-user committed Nov 1, 2024
1 parent c573490 commit b240dfd
Show file tree
Hide file tree
Showing 33 changed files with 1,417 additions and 471 deletions.
1 change: 1 addition & 0 deletions _autosummary/one.alf.cache.html
Original file line number Diff line number Diff line change
Expand Up @@ -84,6 +84,7 @@
<li class="toctree-l4"><a class="reference internal" href="one.alf.exceptions.html">one.alf.exceptions</a></li>
<li class="toctree-l4"><a class="reference internal" href="one.alf.files.html">one.alf.files</a></li>
<li class="toctree-l4"><a class="reference internal" href="one.alf.io.html">one.alf.io</a></li>
<li class="toctree-l4"><a class="reference internal" href="one.alf.path.html">one.alf.path</a></li>
<li class="toctree-l4"><a class="reference internal" href="one.alf.spec.html">one.alf.spec</a></li>
</ul>
</li>
Expand Down
1 change: 1 addition & 0 deletions _autosummary/one.alf.exceptions.html
Original file line number Diff line number Diff line change
Expand Up @@ -84,6 +84,7 @@
<li class="toctree-l4 current"><a class="current reference internal" href="#">one.alf.exceptions</a></li>
<li class="toctree-l4"><a class="reference internal" href="one.alf.files.html">one.alf.files</a></li>
<li class="toctree-l4"><a class="reference internal" href="one.alf.io.html">one.alf.io</a></li>
<li class="toctree-l4"><a class="reference internal" href="one.alf.path.html">one.alf.path</a></li>
<li class="toctree-l4"><a class="reference internal" href="one.alf.spec.html">one.alf.spec</a></li>
</ul>
</li>
Expand Down
428 changes: 3 additions & 425 deletions _autosummary/one.alf.files.html

Large diffs are not rendered by default.

8 changes: 6 additions & 2 deletions _autosummary/one.alf.html
Original file line number Diff line number Diff line change
Expand Up @@ -84,6 +84,7 @@
<li class="toctree-l4"><a class="reference internal" href="one.alf.exceptions.html">one.alf.exceptions</a></li>
<li class="toctree-l4"><a class="reference internal" href="one.alf.files.html">one.alf.files</a></li>
<li class="toctree-l4"><a class="reference internal" href="one.alf.io.html">one.alf.io</a></li>
<li class="toctree-l4"><a class="reference internal" href="one.alf.path.html">one.alf.path</a></li>
<li class="toctree-l4"><a class="reference internal" href="one.alf.spec.html">one.alf.spec</a></li>
</ul>
</li>
Expand Down Expand Up @@ -142,12 +143,15 @@
<td><p>ALyx File related errors and warnings.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="one.alf.files.html#module-one.alf.files" title="one.alf.files"><code class="xref py py-obj docutils literal notranslate"><span class="pre">files</span></code></a></p></td>
<td><p>Module for identifying and parsing ALF file names.</p></td>
<td><p>(DEPRECATED) Module for identifying and parsing ALF file names.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="one.alf.io.html#module-one.alf.io" title="one.alf.io"><code class="xref py py-obj docutils literal notranslate"><span class="pre">io</span></code></a></p></td>
<td><p>I/O functions for ALyx Files.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="one.alf.spec.html#module-one.alf.spec" title="one.alf.spec"><code class="xref py py-obj docutils literal notranslate"><span class="pre">spec</span></code></a></p></td>
<tr class="row-odd"><td><p><a class="reference internal" href="one.alf.path.html#module-one.alf.path" title="one.alf.path"><code class="xref py py-obj docutils literal notranslate"><span class="pre">path</span></code></a></p></td>
<td><p>Module for identifying and parsing ALF file names.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="one.alf.spec.html#module-one.alf.spec" title="one.alf.spec"><code class="xref py py-obj docutils literal notranslate"><span class="pre">spec</span></code></a></p></td>
<td><p>The complete ALF specification descriptors and validators.</p></td>
</tr>
</tbody>
Expand Down
5 changes: 3 additions & 2 deletions _autosummary/one.alf.io.html
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@
<script src="../_static/js/theme.js"></script>
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
<link rel="next" title="one.alf.spec" href="one.alf.spec.html" />
<link rel="next" title="one.alf.path" href="one.alf.path.html" />
<link rel="prev" title="one.alf.files" href="one.alf.files.html" />
</head>

Expand Down Expand Up @@ -84,6 +84,7 @@
<li class="toctree-l4"><a class="reference internal" href="one.alf.exceptions.html">one.alf.exceptions</a></li>
<li class="toctree-l4"><a class="reference internal" href="one.alf.files.html">one.alf.files</a></li>
<li class="toctree-l4 current"><a class="current reference internal" href="#">one.alf.io</a></li>
<li class="toctree-l4"><a class="reference internal" href="one.alf.path.html">one.alf.path</a></li>
<li class="toctree-l4"><a class="reference internal" href="one.alf.spec.html">one.alf.spec</a></li>
</ul>
</li>
Expand Down Expand Up @@ -663,7 +664,7 @@
</div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="one.alf.files.html" class="btn btn-neutral float-left" title="one.alf.files" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<a href="one.alf.spec.html" class="btn btn-neutral float-right" title="one.alf.spec" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
<a href="one.alf.path.html" class="btn btn-neutral float-right" title="one.alf.path" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
</div>

<hr/>
Expand Down
595 changes: 595 additions & 0 deletions _autosummary/one.alf.path.html

Large diffs are not rendered by default.

1 change: 1 addition & 0 deletions _autosummary/one.alf.spec.COLLECTION_SPEC.html
Original file line number Diff line number Diff line change
Expand Up @@ -84,6 +84,7 @@
<li class="toctree-l4"><a class="reference internal" href="one.alf.exceptions.html">one.alf.exceptions</a></li>
<li class="toctree-l4"><a class="reference internal" href="one.alf.files.html">one.alf.files</a></li>
<li class="toctree-l4"><a class="reference internal" href="one.alf.io.html">one.alf.io</a></li>
<li class="toctree-l4"><a class="reference internal" href="one.alf.path.html">one.alf.path</a></li>
<li class="toctree-l4 current"><a class="reference internal" href="one.alf.spec.html">one.alf.spec</a></li>
</ul>
</li>
Expand Down
1 change: 1 addition & 0 deletions _autosummary/one.alf.spec.FILE_SPEC.html
Original file line number Diff line number Diff line change
Expand Up @@ -84,6 +84,7 @@
<li class="toctree-l4"><a class="reference internal" href="one.alf.exceptions.html">one.alf.exceptions</a></li>
<li class="toctree-l4"><a class="reference internal" href="one.alf.files.html">one.alf.files</a></li>
<li class="toctree-l4"><a class="reference internal" href="one.alf.io.html">one.alf.io</a></li>
<li class="toctree-l4"><a class="reference internal" href="one.alf.path.html">one.alf.path</a></li>
<li class="toctree-l4 current"><a class="reference internal" href="one.alf.spec.html">one.alf.spec</a></li>
</ul>
</li>
Expand Down
1 change: 1 addition & 0 deletions _autosummary/one.alf.spec.FULL_SPEC.html
Original file line number Diff line number Diff line change
Expand Up @@ -84,6 +84,7 @@
<li class="toctree-l4"><a class="reference internal" href="one.alf.exceptions.html">one.alf.exceptions</a></li>
<li class="toctree-l4"><a class="reference internal" href="one.alf.files.html">one.alf.files</a></li>
<li class="toctree-l4"><a class="reference internal" href="one.alf.io.html">one.alf.io</a></li>
<li class="toctree-l4"><a class="reference internal" href="one.alf.path.html">one.alf.path</a></li>
<li class="toctree-l4 current"><a class="reference internal" href="one.alf.spec.html">one.alf.spec</a></li>
</ul>
</li>
Expand Down
1 change: 1 addition & 0 deletions _autosummary/one.alf.spec.REL_PATH_SPEC.html
Original file line number Diff line number Diff line change
Expand Up @@ -84,6 +84,7 @@
<li class="toctree-l4"><a class="reference internal" href="one.alf.exceptions.html">one.alf.exceptions</a></li>
<li class="toctree-l4"><a class="reference internal" href="one.alf.files.html">one.alf.files</a></li>
<li class="toctree-l4"><a class="reference internal" href="one.alf.io.html">one.alf.io</a></li>
<li class="toctree-l4"><a class="reference internal" href="one.alf.path.html">one.alf.path</a></li>
<li class="toctree-l4 current"><a class="reference internal" href="one.alf.spec.html">one.alf.spec</a></li>
</ul>
</li>
Expand Down
1 change: 1 addition & 0 deletions _autosummary/one.alf.spec.SESSION_SPEC.html
Original file line number Diff line number Diff line change
Expand Up @@ -84,6 +84,7 @@
<li class="toctree-l4"><a class="reference internal" href="one.alf.exceptions.html">one.alf.exceptions</a></li>
<li class="toctree-l4"><a class="reference internal" href="one.alf.files.html">one.alf.files</a></li>
<li class="toctree-l4"><a class="reference internal" href="one.alf.io.html">one.alf.io</a></li>
<li class="toctree-l4"><a class="reference internal" href="one.alf.path.html">one.alf.path</a></li>
<li class="toctree-l4 current"><a class="reference internal" href="one.alf.spec.html">one.alf.spec</a></li>
</ul>
</li>
Expand Down
1 change: 1 addition & 0 deletions _autosummary/one.alf.spec.SPEC_DESCRIPTION.html
Original file line number Diff line number Diff line change
Expand Up @@ -84,6 +84,7 @@
<li class="toctree-l4"><a class="reference internal" href="one.alf.exceptions.html">one.alf.exceptions</a></li>
<li class="toctree-l4"><a class="reference internal" href="one.alf.files.html">one.alf.files</a></li>
<li class="toctree-l4"><a class="reference internal" href="one.alf.io.html">one.alf.io</a></li>
<li class="toctree-l4"><a class="reference internal" href="one.alf.path.html">one.alf.path</a></li>
<li class="toctree-l4 current"><a class="reference internal" href="one.alf.spec.html">one.alf.spec</a></li>
</ul>
</li>
Expand Down
5 changes: 3 additions & 2 deletions _autosummary/one.alf.spec.html
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
<link rel="next" title="one.alf.spec.SPEC_DESCRIPTION" href="one.alf.spec.SPEC_DESCRIPTION.html" />
<link rel="prev" title="one.alf.io" href="one.alf.io.html" />
<link rel="prev" title="one.alf.path" href="one.alf.path.html" />
</head>

<body class="wy-body-for-nav">
Expand Down Expand Up @@ -84,6 +84,7 @@
<li class="toctree-l4"><a class="reference internal" href="one.alf.exceptions.html">one.alf.exceptions</a></li>
<li class="toctree-l4"><a class="reference internal" href="one.alf.files.html">one.alf.files</a></li>
<li class="toctree-l4"><a class="reference internal" href="one.alf.io.html">one.alf.io</a></li>
<li class="toctree-l4"><a class="reference internal" href="one.alf.path.html">one.alf.path</a></li>
<li class="toctree-l4 current"><a class="current reference internal" href="#">one.alf.spec</a></li>
</ul>
</li>
Expand Down Expand Up @@ -525,7 +526,7 @@
</div>
</div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="one.alf.io.html" class="btn btn-neutral float-left" title="one.alf.io" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<a href="one.alf.path.html" class="btn btn-neutral float-left" title="one.alf.path" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<a href="one.alf.spec.SPEC_DESCRIPTION.html" class="btn btn-neutral float-right" title="one.alf.spec.SPEC_DESCRIPTION" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
</div>

Expand Down
15 changes: 15 additions & 0 deletions _autosummary/one.tests.alf.test_alf_files.html
Original file line number Diff line number Diff line change
Expand Up @@ -148,6 +148,9 @@
<tr class="row-even"><td><p><a class="reference internal" href="#one.tests.alf.test_alf_files.TestAlfParse" title="one.tests.alf.test_alf_files.TestAlfParse"><code class="xref py py-obj docutils literal notranslate"><span class="pre">TestAlfParse</span></code></a></p></td>
<td><p>Tests for ALF parsing methods</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#one.tests.alf.test_alf_files.TestFilesDeprecation" title="one.tests.alf.test_alf_files.TestFilesDeprecation"><code class="xref py py-obj docutils literal notranslate"><span class="pre">TestFilesDeprecation</span></code></a></p></td>
<td><p>Test files module warns of deprecation.</p></td>
</tr>
</tbody>
</table>
<dl class="py class">
Expand Down Expand Up @@ -236,6 +239,18 @@

</dd></dl>

<dl class="py class">
<dt class="sig sig-object py" id="one.tests.alf.test_alf_files.TestFilesDeprecation">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">TestFilesDeprecation</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">methodName</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'runTest'</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/one/tests/alf/test_alf_files.html#TestFilesDeprecation"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#one.tests.alf.test_alf_files.TestFilesDeprecation" title="Link to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">TestCase</span></code></p>
<p>Test files module warns of deprecation.</p>
<dl class="py method">
<dt class="sig sig-object py" id="one.tests.alf.test_alf_files.TestFilesDeprecation.test_deprecation">
<span class="sig-name descname"><span class="pre">test_deprecation</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/one/tests/alf/test_alf_files.html#TestFilesDeprecation.test_deprecation"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#one.tests.alf.test_alf_files.TestFilesDeprecation.test_deprecation" title="Link to this definition"></a></dt>
<dd></dd></dl>

</dd></dl>

</section>


Expand Down
2 changes: 1 addition & 1 deletion _modules/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -106,8 +106,8 @@
<h1>All modules for which code is available</h1>
<ul><li><a href="one/alf/cache.html">one.alf.cache</a></li>
<li><a href="one/alf/exceptions.html">one.alf.exceptions</a></li>
<li><a href="one/alf/files.html">one.alf.files</a></li>
<li><a href="one/alf/io.html">one.alf.io</a></li>
<li><a href="one/alf/path.html">one.alf.path</a></li>
<li><a href="one/alf/spec.html">one.alf.spec</a></li>
<li><a href="one/api.html">one.api</a></li>
<li><a href="one/converters.html">one.converters</a></li>
Expand Down
2 changes: 1 addition & 1 deletion _modules/one/alf/cache.html
Original file line number Diff line number Diff line change
Expand Up @@ -135,7 +135,7 @@ <h1>Source code for one.alf.cache</h1><div class="highlight"><pre>
<span class="kn">from</span> <span class="nn">iblutil.io.hashfile</span> <span class="kn">import</span> <span class="n">md5</span>

<span class="kn">from</span> <span class="nn">one.alf.io</span> <span class="kn">import</span> <span class="n">iter_sessions</span><span class="p">,</span> <span class="n">iter_datasets</span>
<span class="kn">from</span> <span class="nn">one.alf.files</span> <span class="kn">import</span> <span class="n">session_path_parts</span><span class="p">,</span> <span class="n">get_alf_path</span>
<span class="kn">from</span> <span class="nn">one.alf.path</span> <span class="kn">import</span> <span class="n">session_path_parts</span><span class="p">,</span> <span class="n">get_alf_path</span>
<span class="kn">from</span> <span class="nn">one.converters</span> <span class="kn">import</span> <span class="n">session_record2path</span>
<span class="kn">from</span> <span class="nn">one.util</span> <span class="kn">import</span> <span class="n">QC_TYPE</span><span class="p">,</span> <span class="n">patch_cache</span>

Expand Down
2 changes: 1 addition & 1 deletion _modules/one/alf/io.html
Original file line number Diff line number Diff line change
Expand Up @@ -133,7 +133,7 @@ <h1>Source code for one.alf.io</h1><div class="highlight"><pre>
<span class="kn">from</span> <span class="nn">iblutil.io</span> <span class="kn">import</span> <span class="n">parquet</span>
<span class="kn">from</span> <span class="nn">iblutil.io</span> <span class="kn">import</span> <span class="n">jsonable</span>
<span class="kn">from</span> <span class="nn">.exceptions</span> <span class="kn">import</span> <span class="n">ALFObjectNotFound</span>
<span class="kn">from</span> <span class="nn">.</span> <span class="kn">import</span> <span class="n">files</span><span class="p">,</span> <span class="n">spec</span>
<span class="kn">from</span> <span class="nn">.</span> <span class="kn">import</span> <span class="n">spec</span><span class="p">,</span> <span class="n">path</span> <span class="k">as</span> <span class="n">files</span>
<span class="kn">from</span> <span class="nn">.spec</span> <span class="kn">import</span> <span class="n">FILE_SPEC</span>

<span class="n">_logger</span> <span class="o">=</span> <span class="n">logging</span><span class="o">.</span><span class="n">getLogger</span><span class="p">(</span><span class="vm">__name__</span><span class="p">)</span>
Expand Down
Loading

0 comments on commit b240dfd

Please sign in to comment.