Skip to content

Commit

Permalink
Merge pull request #45 from emu-project/dev-docs
Browse files Browse the repository at this point in the history 
[ENH] updated docs for package organization
  • Loading branch information
@nmuncy
nmuncy authored May 19, 2022
2 parents 75452fe + 5b6edf5 commit 74c15d2
Show file tree
Hide file tree
Showing 23 changed files with 31 additions and 152 deletions.
Binary file modified docs/_build/doctrees/environment.pickle
View file
Binary file not shown.
Binary file modified docs/_build/doctrees/index.doctree
View file
Binary file not shown.
Binary file modified docs/_build/doctrees/modules.doctree
View file
Binary file not shown.
Binary file removed docs/_build/doctrees/setup.doctree
View file
Binary file not shown.
2 changes: 1 addition & 1 deletion docs/_build/html/_sources/index.rst.txt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ Welcome to func_processing's documentation!
===========================================

.. toctree::
:maxdepth: 3
:maxdepth: 2
:caption: Package Contents:

modules
Expand Down
1 change: 0 additions & 1 deletion docs/_build/html/_sources/modules.rst.txt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,3 @@ func_processing
:maxdepth: 4

func_processing
setup
7 changes: 0 additions & 7 deletions docs/_build/html/_sources/setup.rst.txt
View file

This file was deleted.

13 changes: 12 additions & 1 deletion docs/_build/html/func_processing.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,18 @@
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
<p class="caption"><span class="caption-text">Package Contents:</span></p>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="modules.html">func_processing</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="modules.html">func_processing</a><ul class="current">
<li class="toctree-l2 current"><a class="current reference internal" href="#">func_processing package</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#subpackages">Subpackages</a><ul>
<li class="toctree-l4"><a class="reference internal" href="func_processing.resources.html">func_processing.resources package</a></li>
<li class="toctree-l4"><a class="reference internal" href="func_processing.workflow.html">func_processing.workflow package</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#module-func_processing">Module contents</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">func_processing package</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#subpackages">Subpackages</a><ul>
<li class="toctree-l3"><a class="reference internal" href="func_processing.resources.html">func_processing.resources package</a></li>
Expand Down
1 change: 0 additions & 1 deletion docs/_build/html/func_processing.resources.afni.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,6 @@
<li class="toctree-l3"><a class="reference internal" href="func_processing.html#module-func_processing">Module contents</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="setup.html">setup module</a></li>
</ul>
</li>
<li class="toctree-l1 current"><a class="reference internal" href="func_processing.html">func_processing package</a><ul class="current">
Expand Down
1 change: 0 additions & 1 deletion docs/_build/html/func_processing.resources.ashs.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,6 @@
<li class="toctree-l3"><a class="reference internal" href="func_processing.html#module-func_processing">Module contents</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="setup.html">setup module</a></li>
</ul>
</li>
<li class="toctree-l1 current"><a class="reference internal" href="func_processing.html">func_processing package</a><ul class="current">
Expand Down
1 change: 0 additions & 1 deletion docs/_build/html/func_processing.resources.fmriprep.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,6 @@
<li class="toctree-l3"><a class="reference internal" href="func_processing.html#module-func_processing">Module contents</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="setup.html">setup module</a></li>
</ul>
</li>
<li class="toctree-l1 current"><a class="reference internal" href="func_processing.html">func_processing package</a><ul class="current">
Expand Down
1 change: 0 additions & 1 deletion docs/_build/html/func_processing.resources.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,6 @@
<li class="toctree-l3"><a class="reference internal" href="func_processing.html#module-func_processing">Module contents</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="setup.html">setup module</a></li>
</ul>
</li>
<li class="toctree-l1 current"><a class="reference internal" href="func_processing.html">func_processing package</a><ul class="current">
Expand Down
1 change: 0 additions & 1 deletion docs/_build/html/func_processing.resources.reports.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,6 @@
<li class="toctree-l3"><a class="reference internal" href="func_processing.html#module-func_processing">Module contents</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="setup.html">setup module</a></li>
</ul>
</li>
<li class="toctree-l1 current"><a class="reference internal" href="func_processing.html">func_processing package</a><ul class="current">
Expand Down
15 changes: 12 additions & 3 deletions docs/_build/html/func_processing.workflow.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,6 @@
<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="setup module" href="setup.html" />
<link rel="prev" title="func_processing.resources.reports package" href="func_processing.resources.reports.html" />
</head>

Expand All @@ -37,7 +36,18 @@
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
<p class="caption"><span class="caption-text">Package Contents:</span></p>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="modules.html">func_processing</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="modules.html">func_processing</a><ul class="current">
<li class="toctree-l2 current"><a class="reference internal" href="func_processing.html">func_processing package</a><ul class="current">
<li class="toctree-l3 current"><a class="reference internal" href="func_processing.html#subpackages">Subpackages</a><ul class="current">
<li class="toctree-l4"><a class="reference internal" href="func_processing.resources.html">func_processing.resources package</a></li>
<li class="toctree-l4 current"><a class="current reference internal" href="#">func_processing.workflow package</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="func_processing.html#module-func_processing">Module contents</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l1 current"><a class="reference internal" href="func_processing.html">func_processing package</a><ul class="current">
<li class="toctree-l2 current"><a class="reference internal" href="func_processing.html#subpackages">Subpackages</a><ul class="current">
<li class="toctree-l3"><a class="reference internal" href="func_processing.resources.html">func_processing.resources package</a></li>
Expand Down Expand Up @@ -434,7 +444,6 @@ <h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this
</div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="func_processing.resources.reports.html" class="btn btn-neutral float-left" title="func_processing.resources.reports package" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<a href="setup.html" class="btn btn-neutral float-right" title="setup module" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
</div>

<hr/>
Expand Down
13 changes: 2 additions & 11 deletions docs/_build/html/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -70,20 +70,11 @@ <h1>Welcome to func_processing’s documentation!<a class="headerlink" href="#we
<p class="caption"><span class="caption-text">Package Contents:</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="modules.html">func_processing</a><ul>
<li class="toctree-l2"><a class="reference internal" href="func_processing.html">func_processing package</a><ul>
<li class="toctree-l3"><a class="reference internal" href="func_processing.html#subpackages">Subpackages</a></li>
<li class="toctree-l3"><a class="reference internal" href="func_processing.html#module-func_processing">Module contents</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="setup.html">setup module</a></li>
<li class="toctree-l2"><a class="reference internal" href="func_processing.html">func_processing package</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="func_processing.html">func_processing package</a><ul>
<li class="toctree-l2"><a class="reference internal" href="func_processing.html#subpackages">Subpackages</a><ul>
<li class="toctree-l3"><a class="reference internal" href="func_processing.resources.html">func_processing.resources package</a></li>
<li class="toctree-l3"><a class="reference internal" href="func_processing.workflow.html">func_processing.workflow package</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="func_processing.html#subpackages">Subpackages</a></li>
<li class="toctree-l2"><a class="reference internal" href="func_processing.html#module-func_processing">Module contents</a></li>
</ul>
</li>
Expand Down
2 changes: 0 additions & 2 deletions docs/_build/html/modules.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,6 @@
<ul class="current">
<li class="toctree-l1 current"><a class="current reference internal" href="#">func_processing</a><ul>
<li class="toctree-l2"><a class="reference internal" href="func_processing.html">func_processing package</a></li>
<li class="toctree-l2"><a class="reference internal" href="setup.html">setup module</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="func_processing.html">func_processing package</a></li>
Expand Down Expand Up @@ -94,7 +93,6 @@ <h1>func_processing<a class="headerlink" href="#func-processing" title="Permalin
<li class="toctree-l2"><a class="reference internal" href="func_processing.html#module-func_processing">Module contents</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="setup.html">setup module</a></li>
</ul>
</div>
</div>
Expand Down
Binary file modified docs/_build/html/objects.inv
View file
Binary file not shown.
2 changes: 1 addition & 1 deletion docs/_build/html/searchindex.js
View file

Large diffs are not rendered by default.

106 changes: 0 additions & 106 deletions docs/_build/html/setup.html
View file

This file was deleted.

7 changes: 2 additions & 5 deletions docs/build_docs.txt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -44,10 +44,7 @@ Edit index.rst - add modules
:caption: Package Contents:

modules
workflow
resources

# $ sphinx-apidoc -o . .. --ext-autodoc
$ sphinx-apidoc -f -o . ..
func_processing

$ sphinx-apidoc -f -o . ../func_processing
$ make html
2 changes: 1 addition & 1 deletion docs/index.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ Welcome to func_processing's documentation!
===========================================

.. toctree::
:maxdepth: 3
:maxdepth: 2
:caption: Package Contents:

modules
Expand Down
1 change: 0 additions & 1 deletion docs/modules.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,3 @@ func_processing
:maxdepth: 4

func_processing
setup
7 changes: 0 additions & 7 deletions docs/setup.rst
View file

This file was deleted.

0 comments on commit 74c15d2

Please sign in to comment.