docs(main): Update docs of development line

nipreps · Aug 28, 2024 · a831f51 · a831f51
1 parent 8735759
commit a831f51
Show file tree

Hide file tree

Showing 46 changed files with 226 additions and 220 deletions.
diff --git a/main/.buildinfo b/main/.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: be959a9f7e86beb3f929b4951b5f22cb
+config: a999463fb7827095b202bb23636b84e2
 tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/main/_modules/eddymotion/cli/parser.html b/main/_modules/eddymotion/cli/parser.html
@@ -5,7 +5,7 @@
     <meta name="color-scheme" content="light dark"><link rel="index" title="Index" href="../../../genindex.html" /><link rel="search" title="Search" href="../../../search.html" />
 
     <!-- Generated with Sphinx 7.4.7 and Furo 2024.08.06 -->
-        <title>eddymotion.cli.parser - eddymotion 24.0.0.dev101 documentation</title>
+        <title>eddymotion.cli.parser - eddymotion 24.0.0.dev102 documentation</title>
       <link rel="stylesheet" type="text/css" href="../../../_static/pygments.css?v=a746c00c" />
     <link rel="stylesheet" type="text/css" href="../../../_static/styles/furo.css?v=354aac6f" />
     <link rel="stylesheet" type="text/css" href="../../../_static/styles/furo-extensions.css?v=302659d7" />
@@ -166,7 +166,7 @@
       </label>
     </div>
     <div class="header-center">
-      <a href="../../../index.html"><div class="brand">eddymotion 24.0.0.dev101 documentation</div></a>
+      <a href="../../../index.html"><div class="brand">eddymotion 24.0.0.dev102 documentation</div></a>
     </div>
     <div class="header-right">
       <div class="theme-toggle-container theme-toggle-header">
@@ -189,14 +189,14 @@
 
       <div class="sidebar-sticky"><a class="sidebar-brand" href="../../../index.html">
     <span class="sidebar-brand-text">eddymotion</span>
-    <span id="version-slug" class="sidebar-brand-text">24.0.0.dev101</span>
+    <span id="version-slug" class="sidebar-brand-text">24.0.0.dev102</span>
 </a>
 
 <!-- Versions dropdown -->
 <div id="version-menu" class="version-tree">
   <ul>
   <li class="toctree-l1 has-children">
-  <span class="sidebar-brand-text">24.0.0.dev101</span>
+  <span class="sidebar-brand-text">24.0.0.dev102</span>
   <input class="toctree-checkbox" id="toctree-checkbox-v" name="toctree-checkbox-v" role="switch" type="checkbox">
   <label for="toctree-checkbox-v"><div class="visually-hidden">Toggle child pages in navigation</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label>
   <ul id="v-tags"></ul>
@@ -352,7 +352,10 @@ <h1>Source code for eddymotion.cli.parser</h1><div class="highlight"><pre>
         <span class="n">action</span><span class="o">=</span><span class="s2">&quot;store&quot;</span><span class="p">,</span>
         <span class="nb">type</span><span class="o">=</span><span class="n">_parse_yaml_config</span><span class="p">,</span>
         <span class="n">default</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
-        <span class="n">help</span><span class="o">=</span><span class="s2">&quot;Path to the yaml file containing the parameters to configure the image registration process.&quot;</span><span class="p">,</span>
+        <span class="n">help</span><span class="o">=</span><span class="p">(</span>
+            <span class="s2">&quot;Path to the yaml file containing the parameters &quot;</span>
+            <span class="s2">&quot;to configure the image registration process.&quot;</span>
+        <span class="p">),</span>
     <span class="p">)</span>
     <span class="n">parser</span><span class="o">.</span><span class="n">add_argument</span><span class="p">(</span>
         <span class="s2">&quot;--models&quot;</span><span class="p">,</span>
@@ -387,7 +390,10 @@ <h1>Source code for eddymotion.cli.parser</h1><div class="highlight"><pre>
         <span class="n">action</span><span class="o">=</span><span class="s2">&quot;store&quot;</span><span class="p">,</span>
         <span class="nb">type</span><span class="o">=</span><span class="n">Path</span><span class="p">,</span>
         <span class="n">default</span><span class="o">=</span><span class="n">Path</span><span class="o">.</span><span class="n">cwd</span><span class="p">(),</span>
-        <span class="n">help</span><span class="o">=</span><span class="s2">&quot;Path to the output directory. Defaults to the current directory. The output file will have the same name as the input file.&quot;</span><span class="p">,</span>
+        <span class="n">help</span><span class="o">=</span><span class="p">(</span>
+            <span class="s2">&quot;Path to the output directory. Defaults to the current directory.&quot;</span>
+            <span class="s2">&quot;The output file will have the same name as the input file.&quot;</span>
+        <span class="p">),</span>
     <span class="p">)</span>
 
     <span class="k">return</span> <span class="n">parser</span>
@@ -446,7 +452,7 @@ <h1>Source code for eddymotion.cli.parser</h1><div class="highlight"><pre>
 
     </aside>
   </div>
-</div><script src="../../../_static/documentation_options.js?v=2f1135d7"></script>
+</div><script src="../../../_static/documentation_options.js?v=18e9bfbd"></script>
     <script src="../../../_static/doctools.js?v=9a2dae69"></script>
     <script src="../../../_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="../../../_static/scripts/furo.js?v=5fa4622c"></script>

diff --git a/main/_modules/eddymotion/cli/run.html b/main/_modules/eddymotion/cli/run.html
@@ -5,7 +5,7 @@
     <meta name="color-scheme" content="light dark"><link rel="index" title="Index" href="../../../genindex.html" /><link rel="search" title="Search" href="../../../search.html" />
 
     <!-- Generated with Sphinx 7.4.7 and Furo 2024.08.06 -->
-        <title>eddymotion.cli.run - eddymotion 24.0.0.dev101 documentation</title>
+        <title>eddymotion.cli.run - eddymotion 24.0.0.dev102 documentation</title>
       <link rel="stylesheet" type="text/css" href="../../../_static/pygments.css?v=a746c00c" />
     <link rel="stylesheet" type="text/css" href="../../../_static/styles/furo.css?v=354aac6f" />
     <link rel="stylesheet" type="text/css" href="../../../_static/styles/furo-extensions.css?v=302659d7" />
@@ -166,7 +166,7 @@
       </label>
     </div>
     <div class="header-center">
-      <a href="../../../index.html"><div class="brand">eddymotion 24.0.0.dev101 documentation</div></a>
+      <a href="../../../index.html"><div class="brand">eddymotion 24.0.0.dev102 documentation</div></a>
     </div>
     <div class="header-right">
       <div class="theme-toggle-container theme-toggle-header">
@@ -189,14 +189,14 @@
 
       <div class="sidebar-sticky"><a class="sidebar-brand" href="../../../index.html">
     <span class="sidebar-brand-text">eddymotion</span>
-    <span id="version-slug" class="sidebar-brand-text">24.0.0.dev101</span>
+    <span id="version-slug" class="sidebar-brand-text">24.0.0.dev102</span>
 </a>
 
 <!-- Versions dropdown -->
 <div id="version-menu" class="version-tree">
   <ul>
   <li class="toctree-l1 has-children">
-  <span class="sidebar-brand-text">24.0.0.dev101</span>
+  <span class="sidebar-brand-text">24.0.0.dev102</span>
   <input class="toctree-checkbox" id="toctree-checkbox-v" name="toctree-checkbox-v" role="switch" type="checkbox">
   <label for="toctree-checkbox-v"><div class="visually-hidden">Toggle child pages in navigation</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label>
   <ul id="v-tags"></ul>
@@ -377,7 +377,7 @@ <h1>Source code for eddymotion.cli.run</h1><div class="highlight"><pre>
 
     </aside>
   </div>
-</div><script src="../../../_static/documentation_options.js?v=2f1135d7"></script>
+</div><script src="../../../_static/documentation_options.js?v=18e9bfbd"></script>
     <script src="../../../_static/doctools.js?v=9a2dae69"></script>
     <script src="../../../_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="../../../_static/scripts/furo.js?v=5fa4622c"></script>

diff --git a/main/_modules/eddymotion/data/dmri.html b/main/_modules/eddymotion/data/dmri.html
@@ -5,7 +5,7 @@
     <meta name="color-scheme" content="light dark"><link rel="index" title="Index" href="../../../genindex.html" /><link rel="search" title="Search" href="../../../search.html" />
 
     <!-- Generated with Sphinx 7.4.7 and Furo 2024.08.06 -->
-        <title>eddymotion.data.dmri - eddymotion 24.0.0.dev101 documentation</title>
+        <title>eddymotion.data.dmri - eddymotion 24.0.0.dev102 documentation</title>
       <link rel="stylesheet" type="text/css" href="../../../_static/pygments.css?v=a746c00c" />
     <link rel="stylesheet" type="text/css" href="../../../_static/styles/furo.css?v=354aac6f" />
     <link rel="stylesheet" type="text/css" href="../../../_static/styles/furo-extensions.css?v=302659d7" />
@@ -166,7 +166,7 @@
       </label>
     </div>
     <div class="header-center">
-      <a href="../../../index.html"><div class="brand">eddymotion 24.0.0.dev101 documentation</div></a>
+      <a href="../../../index.html"><div class="brand">eddymotion 24.0.0.dev102 documentation</div></a>
     </div>
     <div class="header-right">
       <div class="theme-toggle-container theme-toggle-header">
@@ -189,14 +189,14 @@
 
       <div class="sidebar-sticky"><a class="sidebar-brand" href="../../../index.html">
     <span class="sidebar-brand-text">eddymotion</span>
-    <span id="version-slug" class="sidebar-brand-text">24.0.0.dev101</span>
+    <span id="version-slug" class="sidebar-brand-text">24.0.0.dev102</span>
 </a>
 
 <!-- Versions dropdown -->
 <div id="version-menu" class="version-tree">
   <ul>
   <li class="toctree-l1 has-children">
-  <span class="sidebar-brand-text">24.0.0.dev101</span>
+  <span class="sidebar-brand-text">24.0.0.dev102</span>
   <input class="toctree-checkbox" id="toctree-checkbox-v" name="toctree-checkbox-v" role="switch" type="checkbox">
   <label for="toctree-checkbox-v"><div class="visually-hidden">Toggle child pages in navigation</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label>
   <ul id="v-tags"></ul>
@@ -588,7 +588,7 @@ <h1>Source code for eddymotion.data.dmri</h1><div class="highlight"><pre>
 
     </aside>
   </div>
-</div><script src="../../../_static/documentation_options.js?v=2f1135d7"></script>
+</div><script src="../../../_static/documentation_options.js?v=18e9bfbd"></script>
     <script src="../../../_static/doctools.js?v=9a2dae69"></script>
     <script src="../../../_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="../../../_static/scripts/furo.js?v=5fa4622c"></script>

diff --git a/main/_modules/eddymotion/data/filtering.html b/main/_modules/eddymotion/data/filtering.html
@@ -5,7 +5,7 @@
     <meta name="color-scheme" content="light dark"><link rel="index" title="Index" href="../../../genindex.html" /><link rel="search" title="Search" href="../../../search.html" />
 
     <!-- Generated with Sphinx 7.4.7 and Furo 2024.08.06 -->
-        <title>eddymotion.data.filtering - eddymotion 24.0.0.dev101 documentation</title>
+        <title>eddymotion.data.filtering - eddymotion 24.0.0.dev102 documentation</title>
       <link rel="stylesheet" type="text/css" href="../../../_static/pygments.css?v=a746c00c" />
     <link rel="stylesheet" type="text/css" href="../../../_static/styles/furo.css?v=354aac6f" />
     <link rel="stylesheet" type="text/css" href="../../../_static/styles/furo-extensions.css?v=302659d7" />
@@ -166,7 +166,7 @@
       </label>
     </div>
     <div class="header-center">
-      <a href="../../../index.html"><div class="brand">eddymotion 24.0.0.dev101 documentation</div></a>
+      <a href="../../../index.html"><div class="brand">eddymotion 24.0.0.dev102 documentation</div></a>
     </div>
     <div class="header-right">
       <div class="theme-toggle-container theme-toggle-header">
@@ -189,14 +189,14 @@
 
       <div class="sidebar-sticky"><a class="sidebar-brand" href="../../../index.html">
     <span class="sidebar-brand-text">eddymotion</span>
-    <span id="version-slug" class="sidebar-brand-text">24.0.0.dev101</span>
+    <span id="version-slug" class="sidebar-brand-text">24.0.0.dev102</span>
 </a>
 
 <!-- Versions dropdown -->
 <div id="version-menu" class="version-tree">
   <ul>
   <li class="toctree-l1 has-children">
-  <span class="sidebar-brand-text">24.0.0.dev101</span>
+  <span class="sidebar-brand-text">24.0.0.dev102</span>
   <input class="toctree-checkbox" id="toctree-checkbox-v" name="toctree-checkbox-v" role="switch" type="checkbox">
   <label for="toctree-checkbox-v"><div class="visually-hidden">Toggle child pages in navigation</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label>
   <ul id="v-tags"></ul>
@@ -406,7 +406,7 @@ <h1>Source code for eddymotion.data.filtering</h1><div class="highlight"><pre>
 
     </aside>
   </div>
-</div><script src="../../../_static/documentation_options.js?v=2f1135d7"></script>
+</div><script src="../../../_static/documentation_options.js?v=18e9bfbd"></script>
     <script src="../../../_static/doctools.js?v=9a2dae69"></script>
     <script src="../../../_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="../../../_static/scripts/furo.js?v=5fa4622c"></script>

diff --git a/main/_modules/eddymotion/data/pet.html b/main/_modules/eddymotion/data/pet.html
@@ -5,7 +5,7 @@
     <meta name="color-scheme" content="light dark"><link rel="index" title="Index" href="../../../genindex.html" /><link rel="search" title="Search" href="../../../search.html" />
 
     <!-- Generated with Sphinx 7.4.7 and Furo 2024.08.06 -->
-        <title>eddymotion.data.pet - eddymotion 24.0.0.dev101 documentation</title>
+        <title>eddymotion.data.pet - eddymotion 24.0.0.dev102 documentation</title>
       <link rel="stylesheet" type="text/css" href="../../../_static/pygments.css?v=a746c00c" />
     <link rel="stylesheet" type="text/css" href="../../../_static/styles/furo.css?v=354aac6f" />
     <link rel="stylesheet" type="text/css" href="../../../_static/styles/furo-extensions.css?v=302659d7" />
@@ -166,7 +166,7 @@
       </label>
     </div>
     <div class="header-center">
-      <a href="../../../index.html"><div class="brand">eddymotion 24.0.0.dev101 documentation</div></a>
+      <a href="../../../index.html"><div class="brand">eddymotion 24.0.0.dev102 documentation</div></a>
     </div>
     <div class="header-right">
       <div class="theme-toggle-container theme-toggle-header">
@@ -189,14 +189,14 @@
 
       <div class="sidebar-sticky"><a class="sidebar-brand" href="../../../index.html">
     <span class="sidebar-brand-text">eddymotion</span>
-    <span id="version-slug" class="sidebar-brand-text">24.0.0.dev101</span>
+    <span id="version-slug" class="sidebar-brand-text">24.0.0.dev102</span>
 </a>
 
 <!-- Versions dropdown -->
 <div id="version-menu" class="version-tree">
   <ul>
   <li class="toctree-l1 has-children">
-  <span class="sidebar-brand-text">24.0.0.dev101</span>
+  <span class="sidebar-brand-text">24.0.0.dev102</span>
   <input class="toctree-checkbox" id="toctree-checkbox-v" name="toctree-checkbox-v" role="switch" type="checkbox">
   <label for="toctree-checkbox-v"><div class="visually-hidden">Toggle child pages in navigation</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label>
   <ul id="v-tags"></ul>
@@ -505,7 +505,7 @@ <h1>Source code for eddymotion.data.pet</h1><div class="highlight"><pre>
 
     </aside>
   </div>
-</div><script src="../../../_static/documentation_options.js?v=2f1135d7"></script>
+</div><script src="../../../_static/documentation_options.js?v=18e9bfbd"></script>
     <script src="../../../_static/doctools.js?v=9a2dae69"></script>
     <script src="../../../_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="../../../_static/scripts/furo.js?v=5fa4622c"></script>

diff --git a/main/_modules/eddymotion/data/splitting.html b/main/_modules/eddymotion/data/splitting.html
@@ -5,7 +5,7 @@
     <meta name="color-scheme" content="light dark"><link rel="index" title="Index" href="../../../genindex.html" /><link rel="search" title="Search" href="../../../search.html" />
 
     <!-- Generated with Sphinx 7.4.7 and Furo 2024.08.06 -->
-        <title>eddymotion.data.splitting - eddymotion 24.0.0.dev101 documentation</title>
+        <title>eddymotion.data.splitting - eddymotion 24.0.0.dev102 documentation</title>
       <link rel="stylesheet" type="text/css" href="../../../_static/pygments.css?v=a746c00c" />
     <link rel="stylesheet" type="text/css" href="../../../_static/styles/furo.css?v=354aac6f" />
     <link rel="stylesheet" type="text/css" href="../../../_static/styles/furo-extensions.css?v=302659d7" />
@@ -166,7 +166,7 @@
       </label>
     </div>
     <div class="header-center">
-      <a href="../../../index.html"><div class="brand">eddymotion 24.0.0.dev101 documentation</div></a>
+      <a href="../../../index.html"><div class="brand">eddymotion 24.0.0.dev102 documentation</div></a>
     </div>
     <div class="header-right">
       <div class="theme-toggle-container theme-toggle-header">
@@ -189,14 +189,14 @@
 
       <div class="sidebar-sticky"><a class="sidebar-brand" href="../../../index.html">
     <span class="sidebar-brand-text">eddymotion</span>
-    <span id="version-slug" class="sidebar-brand-text">24.0.0.dev101</span>
+    <span id="version-slug" class="sidebar-brand-text">24.0.0.dev102</span>
 </a>
 
 <!-- Versions dropdown -->
 <div id="version-menu" class="version-tree">
   <ul>
   <li class="toctree-l1 has-children">
-  <span class="sidebar-brand-text">24.0.0.dev101</span>
+  <span class="sidebar-brand-text">24.0.0.dev102</span>
   <input class="toctree-checkbox" id="toctree-checkbox-v" name="toctree-checkbox-v" role="switch" type="checkbox">
   <label for="toctree-checkbox-v"><div class="visually-hidden">Toggle child pages in navigation</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label>
   <ul id="v-tags"></ul>
@@ -398,7 +398,7 @@ <h1>Source code for eddymotion.data.splitting</h1><div class="highlight"><pre>
 
     </aside>
   </div>
-</div><script src="../../../_static/documentation_options.js?v=2f1135d7"></script>
+</div><script src="../../../_static/documentation_options.js?v=18e9bfbd"></script>
     <script src="../../../_static/doctools.js?v=9a2dae69"></script>
     <script src="../../../_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="../../../_static/scripts/furo.js?v=5fa4622c"></script>