Merge pull request #179 from ToFuProject/patchfix-doc

Patchfix doc
ToFuProject · Sep 5, 2019 · 56b8b95 · 56b8b95
2 parents 1eefdc8 + fb95884
commit 56b8b95
Show file tree

Hide file tree

Showing 62 changed files with 2,606 additions and 6,405 deletions.
diff --git a/README.md b/README.md
@@ -36,35 +36,35 @@ Here are some examples of what **tofu** can do
 
 #### Built-in one-liners for interactive camera geometry visualization
 <p align="center">
-<img align="middle" src="https://github.com/ToFuProject/tofu/blob/Issue165_READMEFigures/README_figures/CamLOS1D_touch.png" width="600" alt="Built-in one-liners for interactive camera geometry visualization"/>
+<img align="middle" src="https://github.com/ToFuProject/tofu/blob/master/README_figures/CamLOS1D_touch.png" width="600" alt="Built-in one-liners for interactive camera geometry visualization"/>
 </p>
 
 #### ...both for 1D and 2D cameras, including the basics for multiple reflections handling
 <p align="center">
-<img align="middle" src="https://github.com/ToFuProject/tofu/blob/Issue165_READMEFigures/README_figures/CamLOS2D_touch_refelect.png" width="600" alt="...both for 1D and 2D cameras, including the basics for multiple reflections handling"/>
+<img align="middle" src="https://github.com/ToFuProject/tofu/blob/master/README_figures/CamLOS2D_touch_refelect.png" width="600" alt="...both for 1D and 2D cameras, including the basics for multiple reflections handling"/>
 </p>
 
 ####    Built-in plotting of sinograms
 
 <p align="center">
-<img align="middle" src="https://github.com/ToFuProject/tofu/blob/Issue165_READMEFigures/README_figures/CamLOS1D_sino.png" width="600" alt="Built-in plotting of sinograms"/>
+<img align="middle" src="https://github.com/ToFuProject/tofu/blob/master/README_figures/CamLOS1D_sino.png" width="600" alt="Built-in plotting of sinograms"/>
 </p>
 
 ####    Basic magnetic field line tracing
 
 <p align="center">
-<img align="middle" src="https://github.com/ToFuProject/tofu/blob/Issue165_READMEFigures/README_figures/MagfieldLines.png" width="600" alt="Basic magnetic field line tracing"/>
+<img align="middle" src="https://github.com/ToFuProject/tofu/blob/master/README_figures/MagfieldLines.png" width="600" alt="Basic magnetic field line tracing"/>
 </p>
 
 
 ####    Multiple 1d profiles interactive plotting
 <p align="center">
-<img align="middle" src="https://github.com/ToFuProject/tofu/blob/Issue165_READMEFigures/README_figures/Plasma2D_1dneTe.png" width="600" alt="Multiple 1d profiles interactive plotting"/>
+<img align="middle" src="https://github.com/ToFuProject/tofu/blob/master/README_figures/Plasma2D_1dneTe.png" width="600" alt="Multiple 1d profiles interactive plotting"/>
 </p>
 
 ####    Built-in basic data treatment and interactive plotting: svd and spectrograms
 <p align="center">
-<img align="middle" src="https://github.com/ToFuProject/tofu/blob/Issue165_READMEFigures/README_figures/Plasma2D_1dneTe.png" width="600" alt="Built-in basic data treatment and interactive plotting: svd and spectrograms"/>
+<img align="middle" src="https://github.com/ToFuProject/tofu/blob/master/README_figures/Plasma2D_1dneTe.png" width="600" alt="Built-in basic data treatment and interactive plotting: svd and spectrograms"/>
 </p>
 
 

diff --git a/doc/build/doctrees/Auto_tofu.geom.doctree b/doc/build/doctrees/Auto_tofu.geom.doctree
diff --git a/doc/build/doctrees/Auto_tofu.pathfile.doctree b/doc/build/doctrees/Auto_tofu.pathfile.doctree
diff --git a/doc/build/doctrees/Auto_tofu.plugins.AUG.doctree b/doc/build/doctrees/Auto_tofu.plugins.AUG.doctree
diff --git a/doc/build/doctrees/Auto_tofu.plugins.ITER.doctree b/doc/build/doctrees/Auto_tofu.plugins.ITER.doctree
diff --git a/doc/build/doctrees/Auto_tofu.plugins.doctree b/doc/build/doctrees/Auto_tofu.plugins.doctree
diff --git a/doc/build/doctrees/Auto_tofu.treat.doctree b/doc/build/doctrees/Auto_tofu.treat.doctree
diff --git a/doc/build/doctrees/Citation.doctree b/doc/build/doctrees/Citation.doctree
diff --git a/doc/build/doctrees/Dependencies.doctree b/doc/build/doctrees/Dependencies.doctree
diff --git a/doc/build/doctrees/Todos.doctree b/doc/build/doctrees/Todos.doctree
diff --git a/doc/build/doctrees/Tutorial_AUG.doctree b/doc/build/doctrees/Tutorial_AUG.doctree
diff --git a/doc/build/doctrees/Tutorial_Geom_Advanced.doctree b/doc/build/doctrees/Tutorial_Geom_Advanced.doctree
diff --git a/doc/build/doctrees/Tutorial_Geom_HowToCreateGeometry.doctree b/doc/build/doctrees/Tutorial_Geom_HowToCreateGeometry.doctree
diff --git a/doc/build/doctrees/Tutorial_Geom_SynthDiag_Basic.doctree b/doc/build/doctrees/Tutorial_Geom_SynthDiag_Basic.doctree
diff --git a/doc/build/doctrees/Tutorial_ITER.doctree b/doc/build/doctrees/Tutorial_ITER.doctree
diff --git a/doc/build/doctrees/Versions.doctree b/doc/build/doctrees/Versions.doctree
diff --git a/doc/build/doctrees/environment.pickle b/doc/build/doctrees/environment.pickle
diff --git a/doc/build/doctrees/index.doctree b/doc/build/doctrees/index.doctree
diff --git a/doc/build/doctrees/overview.doctree b/doc/build/doctrees/overview.doctree
diff --git a/doc/build/html/.buildinfo b/doc/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: 396f35bc9ac97e5f2534e73d7a02feec
+config: 87fdf96d8d844dcd1e999145186e8b50
 tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/doc/build/html/Auto_tofu.geom.html b/doc/build/html/Auto_tofu.geom.html
diff --git a/doc/build/html/Auto_tofu.pathfile.html b/doc/build/html/Auto_tofu.pathfile.html
diff --git a/doc/build/html/Auto_tofu.plugins.AUG.html b/doc/build/html/Auto_tofu.plugins.AUG.html
diff --git a/doc/build/html/Auto_tofu.plugins.ITER.html b/doc/build/html/Auto_tofu.plugins.ITER.html
diff --git a/doc/build/html/Auto_tofu.plugins.html b/doc/build/html/Auto_tofu.plugins.html
@@ -1,34 +1,24 @@
-<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
-  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
 
+<!DOCTYPE html>
 
 <html xmlns="http://www.w3.org/1999/xhtml">
   <head>
-    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
-
-    <title>4. tofu.plugins &mdash; tofu v1.1</title>
-
+    <meta charset="utf-8" />
+    <title>4. tofu.plugins &#8212; tofu v1.1</title>
     <link rel="stylesheet" href="_static/classic.css" type="text/css" />
     <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
 
-    <script type="text/javascript">
-      var DOCUMENTATION_OPTIONS = {
-        URL_ROOT:    './',
-        VERSION:     '1.1.0',
-        COLLAPSE_INDEX: false,
-        FILE_SUFFIX: '.html',
-        HAS_SOURCE:  true
-      };
-    </script>
+    <script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
     <script type="text/javascript" src="_static/jquery.js"></script>
     <script type="text/javascript" src="_static/underscore.js"></script>
     <script type="text/javascript" src="_static/doctools.js"></script>
-    <script type="text/javascript" src="https://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
-    <link rel="top" title="tofu v1.1" href="index.html" />
+    <script type="text/javascript" src="_static/language_data.js"></script>
+
+    <link rel="index" title="Index" href="genindex.html" />
+    <link rel="search" title="Search" href="search.html" />
     <link rel="next" title="4.1.1. AUG" href="Auto_tofu.plugins.AUG.html" />
     <link rel="prev" title="3. tofu.pathfile" href="Auto_tofu.pathfile.html" /> 
-  </head>
-  <body role="document">
+  </head><body>
     <div class="related" role="navigation" aria-label="related navigation">
       <h3>Navigation</h3>
       <ul>
@@ -44,7 +34,7 @@ <h3>Navigation</h3>
         <li class="right" >
           <a href="Auto_tofu.pathfile.html" title="3. tofu.pathfile"
              accesskey="P">previous</a> |</li>
-        <li class="nav-item nav-item-0"><a href="index.html">tofu v1.1</a> &raquo;</li> 
+        <li class="nav-item nav-item-0"><a href="index.html">tofu v1.1</a> &#187;</li> 
       </ul>
     </div>  
 
@@ -55,7 +45,7 @@ <h3>Navigation</h3>
 
   <div class="section" id="tofu-plugins">
 <span id="overview"></span><h1>4. <strong>tofu.plugins</strong><a class="headerlink" href="#tofu-plugins" title="Permalink to this headline">¶</a></h1>
-<p>In an effort to adapt ToFu to several experiments and ensure a smooth use for non-specialists users, plugins can be developped to adapt ToFu to the local specificities of each laboratory or environment (local computer systems and networks, local geometry and nomenclature, local data storing systems...).</p>
+<p>In an effort to adapt ToFu to several experiments and ensure a smooth use for non-specialists users, plugins can be developped to adapt ToFu to the local specificities of each laboratory or environment (local computer systems and networks, local geometry and nomenclature, local data storing systems…).</p>
 <p>While ToFu in itself is open-source, the plugins, which concentrate everything that is machine-specific, are writen on demand and customized for the local needs, they remain on the local servers and are not provided on the GitHub page of ToFu. It is via the laboratories that you may have access to them.</p>
 <p>The following plugins have been / are being developped:</p>
 <div class="section" id="machine-oriented-plugins">
@@ -70,16 +60,16 @@ <h2>4.1. Machine-oriented plugins<a class="headerlink" href="#machine-oriented-p
 <div class="section" id="code-oriented-plugins">
 <h2>4.2. Code-oriented plugins<a class="headerlink" href="#code-oriented-plugins" title="Permalink to this headline">¶</a></h2>
 <ol class="arabic simple">
-<li><a class="reference external" href="https://www.qwant.com/web">CAID</a></li>
+<li><p><a class="reference external" href="https://www.qwant.com/web">CAID</a></p></li>
 </ol>
 </div>
 <div class="section" id="indices-and-tables">
 <h2>4.3. Indices and tables<a class="headerlink" href="#indices-and-tables" title="Permalink to this headline">¶</a></h2>
 <ul class="simple">
-<li><a class="reference external" href="index.html">Homepage</a></li>
-<li><a class="reference internal" href="genindex.html"><span class="std std-ref">Index</span></a></li>
-<li><a class="reference internal" href="py-modindex.html"><span class="std std-ref">Module Index</span></a></li>
-<li><a class="reference internal" href="search.html"><span class="std std-ref">Search Page</span></a></li>
+<li><p><a class="reference external" href="index.html">Homepage</a></p></li>
+<li><p><a class="reference internal" href="genindex.html"><span class="std std-ref">Index</span></a></p></li>
+<li><p><a class="reference internal" href="py-modindex.html"><span class="std std-ref">Module Index</span></a></p></li>
+<li><p><a class="reference internal" href="search.html"><span class="std std-ref">Search Page</span></a></p></li>
 </ul>
 </div>
 </div>
@@ -90,7 +80,7 @@ <h2>4.3. Indices and tables<a class="headerlink" href="#indices-and-tables" titl
       </div>
       <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
         <div class="sphinxsidebarwrapper">
-  <h3><a href="index.html">Table Of Contents</a></h3>
+  <h3><a href="index.html">Table of Contents</a></h3>
   <ul>
 <li><a class="reference internal" href="#">4. <strong>tofu.plugins</strong></a><ul>
 <li><a class="reference internal" href="#machine-oriented-plugins">4.1. Machine-oriented plugins</a></li>
@@ -109,18 +99,18 @@ <h4>Next topic</h4>
   <div role="note" aria-label="source link">
     <h3>This Page</h3>
     <ul class="this-page-menu">
-      <li><a href="_sources/Auto_tofu.plugins.txt"
+      <li><a href="_sources/Auto_tofu.plugins.rst.txt"
             rel="nofollow">Show Source</a></li>
     </ul>
    </div>
 <div id="searchbox" style="display: none" role="search">
-  <h3>Quick search</h3>
+  <h3 id="searchlabel">Quick search</h3>
+    <div class="searchformwrapper">
     <form class="search" action="search.html" method="get">
-      <div><input type="text" name="q" /></div>
-      <div><input type="submit" value="Go" /></div>
-      <input type="hidden" name="check_keywords" value="yes" />
-      <input type="hidden" name="area" value="default" />
+      <input type="text" name="q" aria-labelledby="searchlabel" />
+      <input type="submit" value="Go" />
     </form>
+    </div>
 </div>
 <script type="text/javascript">$('#searchbox').show(0);</script>
         </div>
@@ -142,12 +132,12 @@ <h3>Navigation</h3>
         <li class="right" >
           <a href="Auto_tofu.pathfile.html" title="3. tofu.pathfile"
              >previous</a> |</li>
-        <li class="nav-item nav-item-0"><a href="index.html">tofu v1.1</a> &raquo;</li> 
+        <li class="nav-item nav-item-0"><a href="index.html">tofu v1.1</a> &#187;</li> 
       </ul>
     </div>
     <div class="footer" role="contentinfo">
-        &copy; Copyright 2016, Didier VEZINET.
-      Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.4.5.
+        &#169; Copyright 2016, Didier VEZINET.
+      Created using <a href="http://sphinx-doc.org/">Sphinx</a> 2.1.2.
     </div>
   </body>
 </html>