rel(0.1.15): Update docs of 0.1 series

0.1/.buildinfo

@@ -1,4 +1,4 @@
 # Sphinx build info version 1
 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
-config: 9bd2a1029333c7b74905f9b3a416cc2c
+config: e6beb00300722bb26eaea39b2c2c79c8
 tags: 645f666f9bcd5a90fca523b33c5a78b7

0.1/_sources/api/eddymotion.cli.parser.rst.txt

@@ -0,0 +1,7 @@
+eddymotion.cli.parser module
+============================
+
+.. automodule:: eddymotion.cli.parser
+   :members:
+   :undoc-members:
+   :show-inheritance:

0.1/_sources/api/eddymotion.cli.rst.txt

@@ -0,0 +1,16 @@
+eddymotion.cli package
+======================
+
+.. automodule:: eddymotion.cli
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Submodules
+----------
+
+.. toctree::
+   :maxdepth: 1
+
+   eddymotion.cli.parser
+   eddymotion.cli.run

0.1/_sources/api/eddymotion.cli.run.rst.txt

@@ -0,0 +1,7 @@
+eddymotion.cli.run module
+=========================
+
+.. automodule:: eddymotion.cli.run
+   :members:
+   :undoc-members:
+   :show-inheritance:

0.1/_sources/api/eddymotion.data.dmri.rst.txt

@@ -0,0 +1,7 @@
+eddymotion.data.dmri module
+===========================
+
+.. automodule:: eddymotion.data.dmri
+   :members:
+   :undoc-members:
+   :show-inheritance:

0.1/_sources/api/eddymotion.data.pet.rst.txt

@@ -0,0 +1,7 @@
+eddymotion.data.pet module
+==========================
+
+.. automodule:: eddymotion.data.pet
+   :members:
+   :undoc-members:
+   :show-inheritance:

0.1/_sources/api/eddymotion.data.rst.txt

@@ -0,0 +1,18 @@
+eddymotion.data package
+=======================
+
+.. automodule:: eddymotion.data
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Submodules
+----------
+
+.. toctree::
+   :maxdepth: 1
+
+   eddymotion.data.dmri
+   eddymotion.data.pet
+   eddymotion.data.splitting
+   eddymotion.data.utils

0.1/_sources/api/eddymotion.data.splitting.rst.txt

@@ -0,0 +1,7 @@
+eddymotion.data.splitting module
+================================
+
+.. automodule:: eddymotion.data.splitting
+   :members:
+   :undoc-members:
+   :show-inheritance:

0.1/_sources/api/eddymotion.data.utils.rst.txt

@@ -0,0 +1,7 @@
+eddymotion.data.utils module
+============================
+
+.. automodule:: eddymotion.data.utils
+   :members:
+   :undoc-members:
+   :show-inheritance:

0.1/_sources/api/eddymotion.model.base.rst.txt

@@ -0,0 +1,7 @@
+eddymotion.model.base module
+============================
+
+.. automodule:: eddymotion.model.base
+   :members:
+   :undoc-members:
+   :show-inheritance:

0.1/_sources/api/eddymotion.model.rst.txt

@@ -1,7 +1,15 @@
-eddymotion.model module
-=======================
+eddymotion.model package
+========================
 
 .. automodule:: eddymotion.model
    :members:
    :undoc-members:
    :show-inheritance:
+
+Submodules
+----------
+
+.. toctree::
+   :maxdepth: 1
+
+   eddymotion.model.base

0.1/_sources/api/eddymotion.utils.rst.txt

@@ -0,0 +1,7 @@
+eddymotion.utils module
+=======================
+
+.. automodule:: eddymotion.utils
+   :members:
+   :undoc-members:
+   :show-inheritance:

0.1/_sources/developers.rst.txt

@@ -0,0 +1,37 @@
+For developers
+==============
+Contributing
+------------
+*Eddymotion* is a project of the *NiPreps Community*, `which specifies the contributing guidelines <https://www.nipreps.org/community/>`__.
+Before delving into the code, please make sure you have read all the guidelines offered online.
+
+Documentation
+-------------
+Documentation sources are found under the ``docs/`` folder, and builds are archived in the `gh-pages <https://github.com/nipreps/eddymotion/tree/gh-pages>`__ branch of the repository.
+With GitHub Pages, the documentation is posted under https://www.nipreps.org/eddymotion.
+We maintain versioned documentation, by storing git tags under ``<major>.<minor>/`` folders, i.e., we do not archive every patch release, but only every minor release.
+In other words, folder ``0.1/`` of the documentation tree contains the documents for the latest release within the *0.1.x* series.
+With every commit (or merge commit) to ``main``, the *development* version of the documentation under the folder ``main/`` is updated too.
+The ``gh-pages`` branch is automatically maintained with `a GitHub Action <https://github.com/nipreps/eddymotion/blob/main/.github/workflows/docs-build-update.yml>`__.
+Please, do not commit manually to ``gh-pages``.
+
+To build the documentation locally, you first need to make sure that ``setuptools_scm[toml] >= 6.2`` is installed in your environment and then::
+
+  $ cd <eddymotion-repository>/
+  $ python -m setuptools_scm  # This will generate ``src/eddymotion/_version.py``
+  $ make -C docs/ html
+
+Library API (application program interface)
+-------------------------------------------
+Information on specific functions, classes, and methods.
+
+.. toctree::
+   :glob:
+
+   api/eddymotion.cli
+   api/eddymotion.data
+   api/eddymotion.data.dmri
+   api/eddymotion.estimator
+   api/eddymotion.model
+   api/eddymotion.utils
+   api/eddymotion.viz

0.1/_sources/index.rst.txt

@@ -1,11 +1,19 @@
 .. include:: links.rst
 .. include:: ../README.rst
+   :end-line: 29
+.. include:: ../README.rst
+   :start-line: 34
+
+
+.. image:: _static/eddymotion-flowchart.svg
+   :alt: The eddymotion flowchart
 
 Contents
 --------
 .. toctree::
     :maxdepth: 3
 
     installation
-    api
+    running
+    developers
     changes

0.1/_sources/running.rst.txt

@@ -0,0 +1,11 @@
+.. _running_eddymotion:
+
+Running *Eddymotion*
+********************
+Command line interface
+----------------------
+.. argparse::
+   :ref: eddymotion.cli.parser._build_parser
+   :prog: eddymotion
+   :nodefault:
+   :nodefaultconst:

0.1/_static/basic.css

@@ -4,7 +4,7 @@
  *
  * Sphinx stylesheet -- basic theme.
  *
- * :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
+ * :copyright: Copyright 2007-2024 by the Sphinx team, see AUTHORS.
  * :license: BSD, see LICENSE for details.
  *
  */
@@ -222,7 +222,7 @@ table.modindextable td {
 /* -- general body styles --------------------------------------------------- */
 
 div.body {
-    min-width: 450px;
+    min-width: 360px;
     max-width: 800px;
 }
 
@@ -237,14 +237,8 @@ a.headerlink {
     visibility: hidden;
 }
 
-a.brackets:before,
-span.brackets > a:before{
-    content: "[";
-}
-
-a.brackets:after,
-span.brackets > a:after {
-    content: "]";
+a:visited {
+    color: #551A8B;
 }
 
 h1:hover > a.headerlink,
@@ -335,12 +329,16 @@ p.sidebar-title {
     font-weight: bold;
 }
 
+nav.contents,
+aside.topic,
 div.admonition, div.topic, blockquote {
     clear: left;
 }
 
 /* -- topics ---------------------------------------------------------------- */
 
+nav.contents,
+aside.topic,
 div.topic {
     border: 1px solid #ccc;
     padding: 7px;
@@ -379,13 +377,17 @@ div.body p.centered {
 
 div.sidebar > :last-child,
 aside.sidebar > :last-child,
+nav.contents > :last-child,
+aside.topic > :last-child,
 div.topic > :last-child,
 div.admonition > :last-child {
     margin-bottom: 0;
 }
 
 div.sidebar::after,
 aside.sidebar::after,
+nav.contents::after,
+aside.topic::after,
 div.topic::after,
 div.admonition::after,
 blockquote::after {
@@ -428,10 +430,6 @@ table.docutils td, table.docutils th {
     border-bottom: 1px solid #aaa;
 }
 
-table.footnote td, table.footnote th {
-    border: 0 !important;
-}
-
 th {
     text-align: left;
     padding-right: 5px;
@@ -615,19 +613,26 @@ ul.simple p {
     margin-bottom: 0;
 }
 
-dl.footnote > dt,
-dl.citation > dt {
+aside.footnote > span,
+div.citation > span {
     float: left;
-    margin-right: 0.5em;
 }
-
-dl.footnote > dd,
-dl.citation > dd {
+aside.footnote > span:last-of-type,
+div.citation > span:last-of-type {
+  padding-right: 0.5em;
+}
+aside.footnote > p {
+  margin-left: 2em;
+}
+div.citation > p {
+  margin-left: 4em;
+}
+aside.footnote > p:last-of-type,
+div.citation > p:last-of-type {
     margin-bottom: 0em;
 }
-
-dl.footnote > dd:after,
-dl.citation > dd:after {
+aside.footnote > p:last-of-type:after,
+div.citation > p:last-of-type:after {
     content: "";
     clear: both;
 }
@@ -644,10 +649,6 @@ dl.field-list > dt {
     padding-right: 5px;
 }
 
-dl.field-list > dt:after {
-    content: ":";
-}
-
 dl.field-list > dd {
     padding-left: 0.5em;
     margin-top: 0em;
@@ -673,6 +674,16 @@ dd {
     margin-left: 30px;
 }
 
+.sig dd {
+    margin-top: 0px;
+    margin-bottom: 0px;
+}
+
+.sig dl {
+    margin-top: 0px;
+    margin-bottom: 0px;
+}
+
 dl > dd:last-child,
 dl > dd:last-child > :last-child {
     margin-bottom: 0;
@@ -741,6 +752,14 @@ abbr, acronym {
     cursor: help;
 }
 
+.translated {
+    background-color: rgba(207, 255, 207, 0.2)
+}
+
+.untranslated {
+    background-color: rgba(255, 207, 207, 0.2)
+}
+
 /* -- code displays --------------------------------------------------------- */
 
 pre {