add some doc

voreille · Jan 24, 2024 · 930216a · 930216a
1 parent 1e28fa9
commit 930216a
Show file tree

Hide file tree

Showing 29 changed files with 19 additions and 93 deletions.
diff --git a/docs/_build/doctrees/authors.doctree b/docs/_build/doctrees/authors.doctree
diff --git a/docs/_build/doctrees/contributing.doctree b/docs/_build/doctrees/contributing.doctree
diff --git a/docs/_build/doctrees/environment.pickle b/docs/_build/doctrees/environment.pickle
diff --git a/docs/_build/doctrees/generated/okapy.dicomconverter.dicom_walker.doctree b/docs/_build/doctrees/generated/okapy.dicomconverter.dicom_walker.doctree
diff --git a/docs/_build/doctrees/generated/okapy.dicomconverter.doctree b/docs/_build/doctrees/generated/okapy.dicomconverter.doctree
diff --git a/docs/_build/doctrees/generated/okapy.doctree b/docs/_build/doctrees/generated/okapy.doctree
diff --git a/docs/_build/doctrees/history.doctree b/docs/_build/doctrees/history.doctree
diff --git a/docs/_build/doctrees/index.doctree b/docs/_build/doctrees/index.doctree
diff --git a/docs/_build/doctrees/installation.doctree b/docs/_build/doctrees/installation.doctree
diff --git a/docs/_build/doctrees/modules.doctree b/docs/_build/doctrees/modules.doctree
diff --git a/docs/_build/doctrees/readme.doctree b/docs/_build/doctrees/readme.doctree
diff --git a/docs/_build/doctrees/usage.doctree b/docs/_build/doctrees/usage.doctree
diff --git a/docs/_build/html/.buildinfo b/docs/_build/html/.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: b5eb7e0f69dddc75ad5eeaa5c74b9ccd
+config: 89954e14a676554ecc745cb9085f966e
 tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/docs/_build/html/_sources/modules.rst.txt b/docs/_build/html/_sources/modules.rst.txt
@@ -4,6 +4,4 @@ Modules
 .. autosummary::
     :toctree: generated
 
-    okapy
-    okapy.dicomconverter
-    okapy.dicomconverter.dicom_walker
+    okapy
diff --git a/docs/_build/html/authors.html b/docs/_build/html/authors.html
@@ -161,8 +161,6 @@
 <li class="toctree-l1"><a class="reference internal" href="usage.html">Usage</a></li>
 <li class="toctree-l1 has-children"><a class="reference internal" href="modules.html">Modules</a><input class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" role="switch" type="checkbox"/><label for="toctree-checkbox-1"><div class="visually-hidden">Toggle navigation of Modules</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
 <li class="toctree-l2"><a class="reference internal" href="generated/okapy.html">okapy</a></li>
-<li class="toctree-l2"><a class="reference internal" href="generated/okapy.dicomconverter.html">okapy.dicomconverter</a></li>
-<li class="toctree-l2"><a class="reference internal" href="generated/okapy.dicomconverter.dicom_walker.html">okapy.dicomconverter.dicom_walker</a></li>
 </ul>
 </li>
 <li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing</a></li>

diff --git a/docs/_build/html/contributing.html b/docs/_build/html/contributing.html
@@ -3,7 +3,7 @@
   <head><meta charset="utf-8"/>
     <meta name="viewport" content="width=device-width,initial-scale=1"/>
     <meta name="color-scheme" content="light dark"><meta name="viewport" content="width=device-width, initial-scale=1" />
-<link rel="index" title="Index" href="genindex.html" /><link rel="search" title="Search" href="search.html" /><link rel="next" title="Credits" href="authors.html" /><link rel="prev" title="okapy.dicomconverter.dicom_walker" href="generated/okapy.dicomconverter.dicom_walker.html" />
+<link rel="index" title="Index" href="genindex.html" /><link rel="search" title="Search" href="search.html" /><link rel="next" title="Credits" href="authors.html" /><link rel="prev" title="okapy" href="generated/okapy.html" />
 
     <!-- Generated with Sphinx 7.2.6 and Furo 2023.09.10 -->
         <title>Contributing - OkaPy 0.1.0 documentation</title>
@@ -161,8 +161,6 @@
 <li class="toctree-l1"><a class="reference internal" href="usage.html">Usage</a></li>
 <li class="toctree-l1 has-children"><a class="reference internal" href="modules.html">Modules</a><input class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" role="switch" type="checkbox"/><label for="toctree-checkbox-1"><div class="visually-hidden">Toggle navigation of Modules</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
 <li class="toctree-l2"><a class="reference internal" href="generated/okapy.html">okapy</a></li>
-<li class="toctree-l2"><a class="reference internal" href="generated/okapy.dicomconverter.html">okapy.dicomconverter</a></li>
-<li class="toctree-l2"><a class="reference internal" href="generated/okapy.dicomconverter.dicom_walker.html">okapy.dicomconverter.dicom_walker</a></li>
 </ul>
 </li>
 <li class="toctree-l1 current current-page"><a class="current reference internal" href="#">Contributing</a></li>
@@ -337,14 +335,14 @@ <h2>Deploying<a class="headerlink" href="#deploying" title="Link to this heading
               </div>
               <svg class="furo-related-icon"><use href="#svg-arrow-right"></use></svg>
             </a>
-          <a class="prev-page" href="generated/okapy.dicomconverter.dicom_walker.html">
+          <a class="prev-page" href="generated/okapy.html">
               <svg class="furo-related-icon"><use href="#svg-arrow-right"></use></svg>
               <div class="page-info">
                 <div class="context">
                   <span>Previous</span>
                 </div>
 
-                <div class="title">okapy.dicomconverter.dicom_walker</div>
+                <div class="title">okapy</div>
 
               </div>
             </a>

diff --git a/docs/_build/html/generated/okapy.dicomconverter.dicom_walker.html b/docs/_build/html/generated/okapy.dicomconverter.dicom_walker.html
@@ -3,7 +3,7 @@
   <head><meta charset="utf-8"/>
     <meta name="viewport" content="width=device-width,initial-scale=1"/>
     <meta name="color-scheme" content="light dark"><meta name="viewport" content="width=device-width, initial-scale=1" />
-<link rel="index" title="Index" href="../genindex.html" /><link rel="search" title="Search" href="../search.html" /><link rel="next" title="Contributing" href="../contributing.html" /><link rel="prev" title="okapy.dicomconverter" href="okapy.dicomconverter.html" />
+<link rel="index" title="Index" href="../genindex.html" /><link rel="search" title="Search" href="../search.html" />
 
     <!-- Generated with Sphinx 7.2.6 and Furo 2023.09.10 -->
         <title>okapy.dicomconverter.dicom_walker - OkaPy 0.1.0 documentation</title>
@@ -155,14 +155,12 @@
 </form>
 <div id="searchbox"></div><div class="sidebar-scroll"><div class="sidebar-tree">
   <p class="caption" role="heading"><span class="caption-text">Contents:</span></p>
-<ul class="current">
+<ul>
 <li class="toctree-l1"><a class="reference internal" href="../readme.html">OkaPy</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../installation.html">Installation</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../usage.html">Usage</a></li>
-<li class="toctree-l1 current has-children"><a class="reference internal" href="../modules.html">Modules</a><input checked="" class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" role="switch" type="checkbox"/><label for="toctree-checkbox-1"><div class="visually-hidden">Toggle navigation of Modules</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul class="current">
+<li class="toctree-l1 has-children"><a class="reference internal" href="../modules.html">Modules</a><input class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" role="switch" type="checkbox"/><label for="toctree-checkbox-1"><div class="visually-hidden">Toggle navigation of Modules</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
 <li class="toctree-l2"><a class="reference internal" href="okapy.html">okapy</a></li>
-<li class="toctree-l2"><a class="reference internal" href="okapy.dicomconverter.html">okapy.dicomconverter</a></li>
-<li class="toctree-l2 current current-page"><a class="current reference internal" href="#">okapy.dicomconverter.dicom_walker</a></li>
 </ul>
 </li>
 <li class="toctree-l1"><a class="reference internal" href="../contributing.html">Contributing</a></li>
@@ -226,26 +224,8 @@
       <footer>
 
         <div class="related-pages">
-          <a class="next-page" href="../contributing.html">
-              <div class="page-info">
-                <div class="context">
-                  <span>Next</span>
-                </div>
-                <div class="title">Contributing</div>
-              </div>
-              <svg class="furo-related-icon"><use href="#svg-arrow-right"></use></svg>
-            </a>
-          <a class="prev-page" href="okapy.dicomconverter.html">
-              <svg class="furo-related-icon"><use href="#svg-arrow-right"></use></svg>
-              <div class="page-info">
-                <div class="context">
-                  <span>Previous</span>
-                </div>
-
-                <div class="title">okapy.dicomconverter</div>
-
-              </div>
-            </a>
+
+
         </div>
         <div class="bottom-of-page">
           <div class="left-details">

diff --git a/docs/_build/html/generated/okapy.dicomconverter.html b/docs/_build/html/generated/okapy.dicomconverter.html
@@ -3,7 +3,7 @@
   <head><meta charset="utf-8"/>
     <meta name="viewport" content="width=device-width,initial-scale=1"/>
     <meta name="color-scheme" content="light dark"><meta name="viewport" content="width=device-width, initial-scale=1" />
-<link rel="index" title="Index" href="../genindex.html" /><link rel="search" title="Search" href="../search.html" /><link rel="next" title="okapy.dicomconverter.dicom_walker" href="okapy.dicomconverter.dicom_walker.html" /><link rel="prev" title="okapy" href="okapy.html" />
+<link rel="index" title="Index" href="../genindex.html" /><link rel="search" title="Search" href="../search.html" />
 
     <!-- Generated with Sphinx 7.2.6 and Furo 2023.09.10 -->
         <title>okapy.dicomconverter - OkaPy 0.1.0 documentation</title>
@@ -155,14 +155,12 @@
 </form>
 <div id="searchbox"></div><div class="sidebar-scroll"><div class="sidebar-tree">
   <p class="caption" role="heading"><span class="caption-text">Contents:</span></p>
-<ul class="current">
+<ul>
 <li class="toctree-l1"><a class="reference internal" href="../readme.html">OkaPy</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../installation.html">Installation</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../usage.html">Usage</a></li>
-<li class="toctree-l1 current has-children"><a class="reference internal" href="../modules.html">Modules</a><input checked="" class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" role="switch" type="checkbox"/><label for="toctree-checkbox-1"><div class="visually-hidden">Toggle navigation of Modules</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul class="current">
+<li class="toctree-l1 has-children"><a class="reference internal" href="../modules.html">Modules</a><input class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" role="switch" type="checkbox"/><label for="toctree-checkbox-1"><div class="visually-hidden">Toggle navigation of Modules</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
 <li class="toctree-l2"><a class="reference internal" href="okapy.html">okapy</a></li>
-<li class="toctree-l2 current current-page"><a class="current reference internal" href="#">okapy.dicomconverter</a></li>
-<li class="toctree-l2"><a class="reference internal" href="okapy.dicomconverter.dicom_walker.html">okapy.dicomconverter.dicom_walker</a></li>
 </ul>
 </li>
 <li class="toctree-l1"><a class="reference internal" href="../contributing.html">Contributing</a></li>
@@ -212,26 +210,8 @@
       <footer>
 
         <div class="related-pages">
-          <a class="next-page" href="okapy.dicomconverter.dicom_walker.html">
-              <div class="page-info">
-                <div class="context">
-                  <span>Next</span>
-                </div>
-                <div class="title">okapy.dicomconverter.dicom_walker</div>
-              </div>
-              <svg class="furo-related-icon"><use href="#svg-arrow-right"></use></svg>
-            </a>
-          <a class="prev-page" href="okapy.html">
-              <svg class="furo-related-icon"><use href="#svg-arrow-right"></use></svg>
-              <div class="page-info">
-                <div class="context">
-                  <span>Previous</span>
-                </div>
-
-                <div class="title">okapy</div>
-
-              </div>
-            </a>
+
+
         </div>
         <div class="bottom-of-page">
           <div class="left-details">

diff --git a/docs/_build/html/generated/okapy.html b/docs/_build/html/generated/okapy.html
@@ -3,7 +3,7 @@
   <head><meta charset="utf-8"/>
     <meta name="viewport" content="width=device-width,initial-scale=1"/>
     <meta name="color-scheme" content="light dark"><meta name="viewport" content="width=device-width, initial-scale=1" />
-<link rel="index" title="Index" href="../genindex.html" /><link rel="search" title="Search" href="../search.html" /><link rel="next" title="okapy.dicomconverter" href="okapy.dicomconverter.html" /><link rel="prev" title="Modules" href="../modules.html" />
+<link rel="index" title="Index" href="../genindex.html" /><link rel="search" title="Search" href="../search.html" /><link rel="next" title="Contributing" href="../contributing.html" /><link rel="prev" title="Modules" href="../modules.html" />
 
     <!-- Generated with Sphinx 7.2.6 and Furo 2023.09.10 -->
         <title>okapy - OkaPy 0.1.0 documentation</title>
@@ -161,8 +161,6 @@
 <li class="toctree-l1"><a class="reference internal" href="../usage.html">Usage</a></li>
 <li class="toctree-l1 current has-children"><a class="reference internal" href="../modules.html">Modules</a><input checked="" class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" role="switch" type="checkbox"/><label for="toctree-checkbox-1"><div class="visually-hidden">Toggle navigation of Modules</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul class="current">
 <li class="toctree-l2 current current-page"><a class="current reference internal" href="#">okapy</a></li>
-<li class="toctree-l2"><a class="reference internal" href="okapy.dicomconverter.html">okapy.dicomconverter</a></li>
-<li class="toctree-l2"><a class="reference internal" href="okapy.dicomconverter.dicom_walker.html">okapy.dicomconverter.dicom_walker</a></li>
 </ul>
 </li>
 <li class="toctree-l1"><a class="reference internal" href="../contributing.html">Contributing</a></li>
@@ -212,12 +210,12 @@
       <footer>
 
         <div class="related-pages">
-          <a class="next-page" href="okapy.dicomconverter.html">
+          <a class="next-page" href="../contributing.html">
               <div class="page-info">
                 <div class="context">
                   <span>Next</span>
                 </div>
-                <div class="title">okapy.dicomconverter</div>
+                <div class="title">Contributing</div>
               </div>
               <svg class="furo-related-icon"><use href="#svg-arrow-right"></use></svg>
             </a>

diff --git a/docs/_build/html/genindex.html b/docs/_build/html/genindex.html
@@ -159,8 +159,6 @@
 <li class="toctree-l1"><a class="reference internal" href="usage.html">Usage</a></li>
 <li class="toctree-l1 has-children"><a class="reference internal" href="modules.html">Modules</a><input class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" role="switch" type="checkbox"/><label for="toctree-checkbox-1"><div class="visually-hidden">Toggle navigation of Modules</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
 <li class="toctree-l2"><a class="reference internal" href="generated/okapy.html">okapy</a></li>
-<li class="toctree-l2"><a class="reference internal" href="generated/okapy.dicomconverter.html">okapy.dicomconverter</a></li>
-<li class="toctree-l2"><a class="reference internal" href="generated/okapy.dicomconverter.dicom_walker.html">okapy.dicomconverter.dicom_walker</a></li>
 </ul>
 </li>
 <li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing</a></li>

diff --git a/docs/_build/html/history.html b/docs/_build/html/history.html
@@ -161,8 +161,6 @@
 <li class="toctree-l1"><a class="reference internal" href="usage.html">Usage</a></li>
 <li class="toctree-l1 has-children"><a class="reference internal" href="modules.html">Modules</a><input class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" role="switch" type="checkbox"/><label for="toctree-checkbox-1"><div class="visually-hidden">Toggle navigation of Modules</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
 <li class="toctree-l2"><a class="reference internal" href="generated/okapy.html">okapy</a></li>
-<li class="toctree-l2"><a class="reference internal" href="generated/okapy.dicomconverter.html">okapy.dicomconverter</a></li>
-<li class="toctree-l2"><a class="reference internal" href="generated/okapy.dicomconverter.dicom_walker.html">okapy.dicomconverter.dicom_walker</a></li>
 </ul>
 </li>
 <li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing</a></li>

diff --git a/docs/_build/html/index.html b/docs/_build/html/index.html
@@ -161,8 +161,6 @@
 <li class="toctree-l1"><a class="reference internal" href="usage.html">Usage</a></li>
 <li class="toctree-l1 has-children"><a class="reference internal" href="modules.html">Modules</a><input class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" role="switch" type="checkbox"/><label for="toctree-checkbox-1"><div class="visually-hidden">Toggle navigation of Modules</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
 <li class="toctree-l2"><a class="reference internal" href="generated/okapy.html">okapy</a></li>
-<li class="toctree-l2"><a class="reference internal" href="generated/okapy.dicomconverter.html">okapy.dicomconverter</a></li>
-<li class="toctree-l2"><a class="reference internal" href="generated/okapy.dicomconverter.dicom_walker.html">okapy.dicomconverter.dicom_walker</a></li>
 </ul>
 </li>
 <li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing</a></li>
@@ -219,8 +217,6 @@ <h1>Welcome to OkaPy’s documentation!<a class="headerlink" href="#welcome-to-o
 <li class="toctree-l1"><a class="reference internal" href="usage.html">Usage</a></li>
 <li class="toctree-l1"><a class="reference internal" href="modules.html">Modules</a><ul>
 <li class="toctree-l2"><a class="reference internal" href="generated/okapy.html">okapy</a></li>
-<li class="toctree-l2"><a class="reference internal" href="generated/okapy.dicomconverter.html">okapy.dicomconverter</a></li>
-<li class="toctree-l2"><a class="reference internal" href="generated/okapy.dicomconverter.dicom_walker.html">okapy.dicomconverter.dicom_walker</a></li>
 </ul>
 </li>
 <li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing</a><ul>

diff --git a/docs/_build/html/installation.html b/docs/_build/html/installation.html
@@ -161,8 +161,6 @@
 <li class="toctree-l1"><a class="reference internal" href="usage.html">Usage</a></li>
 <li class="toctree-l1 has-children"><a class="reference internal" href="modules.html">Modules</a><input class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" role="switch" type="checkbox"/><label for="toctree-checkbox-1"><div class="visually-hidden">Toggle navigation of Modules</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
 <li class="toctree-l2"><a class="reference internal" href="generated/okapy.html">okapy</a></li>
-<li class="toctree-l2"><a class="reference internal" href="generated/okapy.dicomconverter.html">okapy.dicomconverter</a></li>
-<li class="toctree-l2"><a class="reference internal" href="generated/okapy.dicomconverter.dicom_walker.html">okapy.dicomconverter.dicom_walker</a></li>
 </ul>
 </li>
 <li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing</a></li>