doc

Freakwill · Nov 27, 2024 · e714a60 · e714a60
1 parent 2d62bdf
commit e714a60
Show file tree

Hide file tree

Showing 12 changed files with 12 additions and 14 deletions.
diff --git a/docs/build/doctrees/environment.pickle b/docs/build/doctrees/environment.pickle
diff --git a/docs/build/doctrees/pyrimidine.benchmarks.doctree b/docs/build/doctrees/pyrimidine.benchmarks.doctree
diff --git a/docs/build/doctrees/pyrimidine.doctree b/docs/build/doctrees/pyrimidine.doctree
diff --git a/docs/build/html/_sources/pyrimidine.benchmarks.rst.txt b/docs/build/html/_sources/pyrimidine.benchmarks.rst.txt
@@ -1,5 +1,5 @@
 pyrimidine.benchmarks subpackage
-=============================
+================================
 
 pyrimidine.benchmarks.approximation module
 ------------------------------------------

diff --git a/docs/build/html/_sources/pyrimidine.rst.txt b/docs/build/html/_sources/pyrimidine.rst.txt
@@ -37,7 +37,7 @@ pyrimidine.de module
    :show-inheritance:
 
 pyrimidine.deco module
---------------------
+----------------------
 
 .. automodule:: pyrimidine.deco
    :members:

diff --git a/docs/build/html/objects.inv b/docs/build/html/objects.inv
diff --git a/docs/build/html/pyrimidine.benchmarks.html b/docs/build/html/pyrimidine.benchmarks.html
@@ -39,8 +39,7 @@ <h3>Navigation</h3>
           <a href="pyrimidine.html" title="pyrimidine package"
              accesskey="P">previous</a> |</li>
         <li class="nav-item nav-item-0"><a href="index.html">pyrimidine 1.7 documentation</a> &#187;</li>
-          <li class="nav-item nav-item-1"><a href="Modules.html" >Modules of <cite>pyrimidine</cite></a> &#187;</li>
-          <li class="nav-item nav-item-2"><a href="pyrimidine.html" accesskey="U">pyrimidine package</a> &#187;</li>
+          <li class="nav-item nav-item-1"><a href="pyrimidine.html" accesskey="U">pyrimidine package</a> &#187;</li>
         <li class="nav-item nav-item-this"><a href="">pyrimidine.benchmarks subpackage</a></li> 
       </ul>
     </div>  
@@ -529,8 +528,7 @@ <h3>Navigation</h3>
           <a href="pyrimidine.html" title="pyrimidine package"
              >previous</a> |</li>
         <li class="nav-item nav-item-0"><a href="index.html">pyrimidine 1.7 documentation</a> &#187;</li>
-          <li class="nav-item nav-item-1"><a href="Modules.html" >Modules of <cite>pyrimidine</cite></a> &#187;</li>
-          <li class="nav-item nav-item-2"><a href="pyrimidine.html" >pyrimidine package</a> &#187;</li>
+          <li class="nav-item nav-item-1"><a href="pyrimidine.html" >pyrimidine package</a> &#187;</li>
         <li class="nav-item nav-item-this"><a href="">pyrimidine.benchmarks subpackage</a></li> 
       </ul>
     </div>

diff --git a/docs/build/html/pyrimidine.html b/docs/build/html/pyrimidine.html
@@ -1781,9 +1781,9 @@ <h1>pyrimidine package<a class="headerlink" href="#pyrimidine-package" title="Li
 <dd></dd></dl>
 
 </section>
-<section id="pyrimidine-deco-module">
-<h2>pyrimidine.deco module<a class="headerlink" href="#pyrimidine-deco-module" title="Link to this heading">¶</a></h2>
-<p id="module-pyrimidine.deco">Decorators</p>
+<section id="module-pyrimidine.deco">
+<span id="pyrimidine-deco-module"></span><h2>pyrimidine.deco module<a class="headerlink" href="#module-pyrimidine.deco" title="Link to this heading">¶</a></h2>
+<p>Decorators</p>
 <p>Two main kinds of decorators:
 1. cache decorator: store the information of previous computing, to seep up the algorithm.
 Should clear it to suppress the side effect. It is used with <cite>&#64;side-effect</cite> decorator.
@@ -5273,7 +5273,7 @@ <h3><a href="index.html">Table of Contents</a></h3>
 <li><a class="reference internal" href="#pyrimidine.de.random"><code class="docutils literal notranslate"><span class="pre">random()</span></code></a></li>
 </ul>
 </li>
-<li><a class="reference internal" href="#pyrimidine-deco-module">pyrimidine.deco module</a><ul>
+<li><a class="reference internal" href="#module-pyrimidine.deco">pyrimidine.deco module</a><ul>
 <li><a class="reference internal" href="#pyrimidine.deco.Regester"><code class="docutils literal notranslate"><span class="pre">Regester</span></code></a></li>
 <li><a class="reference internal" href="#pyrimidine.deco.add_cache"><code class="docutils literal notranslate"><span class="pre">add_cache</span></code></a><ul>
 <li><a class="reference internal" href="#pyrimidine.deco.add_cache.attrs"><code class="docutils literal notranslate"><span class="pre">add_cache.attrs</span></code></a></li>

diff --git a/docs/build/html/searchindex.js b/docs/build/html/searchindex.js
diff --git a/docs/conf.py b/docs/conf.py
@@ -64,7 +64,7 @@
 html_static_path = ['_static']
 
 # The master toctree document.
-root_doc = 'source/index'
+# root_doc = 'source/index'
 
 html_domain_indices = True
 

diff --git a/docs/source/pyrimidine.benchmarks.rst b/docs/source/pyrimidine.benchmarks.rst
@@ -1,5 +1,5 @@
 pyrimidine.benchmarks subpackage
-=============================
+================================
 
 pyrimidine.benchmarks.approximation module
 ------------------------------------------

diff --git a/docs/source/pyrimidine.rst b/docs/source/pyrimidine.rst
@@ -37,7 +37,7 @@ pyrimidine.de module
    :show-inheritance:
 
 pyrimidine.deco module
---------------------
+----------------------
 
 .. automodule:: pyrimidine.deco
    :members: