[doc] update documentation and generate doc folder

rmq: recommonmark only work with sphinx 1.7.0 for inline math
codac-team · Feb 17, 2020 · 2e514da · 2e514da
1 parent f785a10
commit 2e514da
Show file tree

Hide file tree

Showing 50 changed files with 3,615 additions and 1,319 deletions.
diff --git a/doc/source/conf.py b/doc/source/conf.py
@@ -37,6 +37,7 @@
 
 mathjax_path="https://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML"
 extensions = [
+    'recommonmark',
     # 'sphinx.ext.imgmath',
     'sphinx.ext.autodoc',
     # 'sphinx.ext.jsmath',
@@ -54,11 +55,11 @@
 # You can specify multiple suffix as a list of string:
 source_suffix = ['.rst', '.md']
 # source_suffix = '.rst'
-from recommonmark.parser import CommonMarkParser
+# from recommonmark.parser import CommonMarkParser
 
-source_parsers = {
-'.md': CommonMarkParser,
-}
+# source_parsers = {
+# '.md': CommonMarkParser,
+# }
 
 # The encoding of source files.
 #source_encoding = 'utf-8-sig'

diff --git a/doc/source/quickstart.md b/doc/source/quickstart.md
@@ -39,7 +39,7 @@ is denoted `$\mathbb{IR}$`
     a = Interval.ALL_REALS # interval [-oo, oo]
     a = Interval(-oo, oo)  # interval [-oo, oo]
     a = Interval()         # interval [-oo, oo]
-    a  = Interval(-2, 3)   # interval [-2, 3]
+    a = Interval(-2, 3)    # interval [-2, 3]
 ```
 
 ## IntervalVector (box)
@@ -54,10 +54,10 @@ With *pyibex* it can be created :
 
 ```python
     # Create IntervalVector
-    IntervalVector( 2, [1,3]) # ==> box [1, 3]x[1,3]
-    IntervalVector( 2, Interval(1,3)) # ==> box [1, 3]x[1,3]
+    IntervalVector( 2, [1,3]) # ==> box [1,3]x[1,3]
+    IntervalVector( 2, Interval(1,3)) # ==> box [1,3]x[1,3]
     IntervalVector([1,2,3]) # ==> box [1,1]x[2,2]x[3,3]
-    IntervalVector([[-1,3], [3,10], [-3, -1]]) # ==> box  [-1,3]x[
+    IntervalVector([[-1,3], [3,10], [-3, -1]]) # ==> box [-1,3]x[3,10]x[-3,-1]
     IntervalVector( [a, Interval(-1,0), Interval(0) ] )
 ```
 
@@ -158,7 +158,7 @@ For instance:
 
 ```
 
-### Operation on
+### Operations on Contractors
 
 ```python
     # CtcIn/CtcOut contractors :math:`$f \in [-2.5, 3.5]$`
@@ -189,3 +189,28 @@ For instance:
     # union of a python list of contractors
     ctc1 = CtcUnion([ctcIn, ctcOut, ctc1])
 ```
+
+## Separators
+### Defintion
+
+A separator `$\mathcal{S}$` is an operator that performs two complementary contractions. Associated with a set `$\mathbb{S}$` and given a box `$[\mathbf{x}]$`, the separator produces two sub-boxes `$[\mathbf{x}_ {in}]$` and `$[\mathbf{x}_{out}]$` that verify:
+```math
+        ([\mathbf{x}] \cap [\mathbf{x}_{in}]) \subset \mathbb{S} \\
+        ([\mathbf{x}] \cap [\mathbf{x}_{out}]) \cap \mathbb{S} = \emptyset
+```
+A separator can also be viewed a as pair of contractors. For efficiency reasons, the separate(…) function takes only two input-output arguments, `$\mathbf{x}_{in}$` and `$\mathbf{x}_{out}$`, each containing initially a copy of the box `$[\mathbf{x}]$`
+### Example
+```python
+    from pyibex import *
+    from vibes import *
+
+    f = Function('x', 'y', 'x*cos(x-y)+y')
+    # build the separator associated to the constraint f(x,y) < 0
+    sep = SepFwdBwd(f, CmpOp.LEQ)
+    # setup the initialbox [-10,10]x[-10,10]
+    box = IntervalVector(2, [-10, 10])
+    vibes.beginDrawing()
+    pySIVIA(box, sep, 0.3)
+    vibes.endDrawing()
+
+```
diff --git a/docs/index.html b/docs/index.html
@@ -90,7 +90,7 @@ <h1>pyIbex</h1>
         <h2>What is pyIbex</h2><br>
 
 
-        <h4><strong>pyIbex</strong>pyibex is set of python modules for solving nonlinear problems using Interval Arithmetic tools. It provides high-level functionalities such as Contractors and Separators programming.<br>
+        <h4><strong>pyIbex</strong> is set of python modules for solving nonlinear problems using Interval Arithmetic tools. It provides high-level functionalities such as Contractors and Separators programming.<br>
         Initially based on the core part of  <a href="http://www.ibex-lib.org/">Ibex-lib</a>, it aims at combining the flexibility of python with the speed of C++ algorithms. <br>
           <!-- It is composed of the following submodules:
           <ul>
@@ -137,7 +137,7 @@ <h4> <b>Remarks:</b> </4>
           <div class="row vertical-align">
             <div class="col-sm-10">
               <h2>Note </h2>
-              <p>To drawn results, we encourage to use <a href="http://enstabretagnerobotics.github.io/VIBES/">VIBes-viewer</a> which provides a simple and fast GUI tool for people working with intervals. The last releases for Window, OSX, and Linux are available <a href=https://github.com/ENSTABretagneRobotics/VIBES/releases/tag/0.2.3>here</a>.
+              <p>To draw results, we recommend to use <a href="http://enstabretagnerobotics.github.io/VIBES/">VIBes-viewer</a> which provides a simple and fast GUI tool for people working with intervals. The last releases for Window, OSX, and Linux are available <a href=https://github.com/ENSTABretagneRobotics/VIBES/releases/tag/0.2.3>here</a>.
               </p>
             </div>
             <div class="col-sm-2">

diff --git a/docs/sphinx/.buildinfo b/docs/sphinx/.buildinfo
@@ -0,0 +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: e34bccacbd9febe15383a365b02b58c0
+tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/docs/sphinx/_modules/index.html b/docs/sphinx/_modules/index.html
@@ -17,40 +17,44 @@
 
 
 
-
-
+  <script type="text/javascript" src="../_static/js/modernizr.min.js"></script>
 
 
+      <script type="text/javascript">
+          var DOCUMENTATION_OPTIONS = {
+              URL_ROOT:'../',
+              VERSION:'1.6.4',
+              LANGUAGE:'None',
+              COLLAPSE_INDEX:false,
+              FILE_SUFFIX:'.html',
+              HAS_SOURCE:  true,
+              SOURCELINK_SUFFIX: '.txt'
+          };
+      </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>
+
+    <script type="text/javascript" src="../_static/js/theme.js"></script>
 
-
-
-
-
-    <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
-
-
-
-
-
-        <link rel="index" title="Index"
-              href="../genindex.html"/>
-        <link rel="search" title="Search" href="../search.html"/>
-    <link rel="top" title="pyibex 1.6.4 documentation" href="../index.html"/> 
+
 
 
-  <script src="../_static/js/modernizr.min.js"></script>
-
+  <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
+  <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
+    <link rel="index" title="Index" href="../genindex.html" />
+    <link rel="search" title="Search" href="../search.html" /> 
 </head>
 
-<body class="wy-body-for-nav" role="document">
+<body class="wy-body-for-nav">
 
 
   <div class="wy-grid-for-nav">
-
 
     <nav data-toggle="wy-nav-shift" class="wy-nav-side">
       <div class="wy-side-scroll">
-        <div class="wy-side-nav-search">
+        <div class="wy-side-nav-search" >
 
 
 
@@ -59,7 +63,7 @@
 
 
 
-            <img src="../_static/pyibex_logo.png" class="logo" />
+            <img src="../_static/pyibex_logo.png" class="logo" alt="Logo"/>
 
           </a>
 
@@ -107,17 +111,18 @@
     <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
 
 
-      <nav class="wy-nav-top" role="navigation" aria-label="top navigation">
+      <nav class="wy-nav-top" aria-label="top navigation">
 
           <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
           <a href="../index.html">pyibex</a>
 
       </nav>
 
 
-
       <div class="wy-nav-content">
+
         <div class="rst-content">
+
 
 
 
@@ -145,8 +150,6 @@
 
       <li class="wy-breadcrumbs-aside">
 
-
-
       </li>
 
   </ul>
@@ -162,9 +165,7 @@ <h1>All modules for which code is available</h1>
 </ul>
 
            </div>
-           <div class="articleComments">
-
-           </div>
+
           </div>
           <footer>
 
@@ -173,11 +174,11 @@ <h1>All modules for which code is available</h1>
 
   <div role="contentinfo">
     <p>
-        &copy; Copyright 2016, Benoit Desrochers.
+        &copy; Copyright 2016, Benoit Desrochers
 
     </p>
   </div>
-  Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>. 
+  Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>. 
 
 </footer>
 
@@ -190,37 +191,15 @@ <h1>All modules for which code is available</h1>
 
 
 
-
-
-    <script type="text/javascript">
-        var DOCUMENTATION_OPTIONS = {
-            URL_ROOT:'../',
-            VERSION:'1.6.4',
-            COLLAPSE_INDEX:false,
-            FILE_SUFFIX:'.html',
-            HAS_SOURCE:  true,
-            SOURCELINK_SUFFIX: '.txt'
-        };
-    </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>
-
-
-
-
-
-    <script type="text/javascript" src="../_static/js/theme.js"></script>
-
-
-
-
   <script type="text/javascript">
       jQuery(function () {
-          SphinxRtdTheme.StickyNav.enable();
+          SphinxRtdTheme.Navigation.enable(true);
       });
   </script>
+
+
+
+
 
 
 </body>

diff --git a/docs/sphinx/_sources/quickstart.md.txt b/docs/sphinx/_sources/quickstart.md.txt
@@ -39,7 +39,7 @@ is denoted `$\mathbb{IR}$`
     a = Interval.ALL_REALS # interval [-oo, oo]
     a = Interval(-oo, oo)  # interval [-oo, oo]
     a = Interval()         # interval [-oo, oo]
-    a  = Interval(-2, 3)   # interval [-2, 3]
+    a = Interval(-2, 3)    # interval [-2, 3]
 ```
 
 ## IntervalVector (box)
@@ -54,10 +54,10 @@ With *pyibex* it can be created :
 
 ```python
     # Create IntervalVector
-    IntervalVector( 2, [1,3]) # ==> box [1, 3]x[1,3]
-    IntervalVector( 2, Interval(1,3)) # ==> box [1, 3]x[1,3]
+    IntervalVector( 2, [1,3]) # ==> box [1,3]x[1,3]
+    IntervalVector( 2, Interval(1,3)) # ==> box [1,3]x[1,3]
     IntervalVector([1,2,3]) # ==> box [1,1]x[2,2]x[3,3]
-    IntervalVector([[-1,3], [3,10], [-3, -1]]) # ==> box  [-1,3]x[
+    IntervalVector([[-1,3], [3,10], [-3, -1]]) # ==> box [-1,3]x[3,10]x[-3,-1]
     IntervalVector( [a, Interval(-1,0), Interval(0) ] )
 ```
 
@@ -158,7 +158,7 @@ For instance:
 
 ```
 
-### Operation on
+### Operations on Contractors
 
 ```python
     # CtcIn/CtcOut contractors :math:`$f \in [-2.5, 3.5]$`
@@ -189,3 +189,28 @@ For instance:
     # union of a python list of contractors
     ctc1 = CtcUnion([ctcIn, ctcOut, ctc1])
 ```
+
+## Separators
+### Defintion
+
+A separator `$\mathcal{S}$` is an operator that performs two complementary contractions. Associated with a set `$\mathbb{S}$` and given a box `$[\mathbf{x}]$`, the separator produces two sub-boxes `$[\mathbf{x}_ {in}]$` and `$[\mathbf{x}_{out}]$` that verify:
+```math
+        ([\mathbf{x}] \cap [\mathbf{x}_{in}]) \subset \mathbb{S} \\
+        ([\mathbf{x}] \cap [\mathbf{x}_{out}]) \cap \mathbb{S} = \emptyset
+```
+A separator can also be viewed a as pair of contractors. For efficiency reasons, the separate(…) function takes only two input-output arguments, `$\mathbf{x}_{in}$` and `$\mathbf{x}_{out}$`, each containing initially a copy of the box `$[\mathbf{x}]$`
+### Example
+```python
+    from pyibex import *
+    from vibes import *
+
+    f = Function('x', 'y', 'x*cos(x-y)+y')
+    # build the separator associated to the constraint f(x,y) < 0
+    sep = SepFwdBwd(f, CmpOp.LEQ)
+    # setup the initialbox [-10,10]x[-10,10]
+    box = IntervalVector(2, [-10, 10])
+    vibes.beginDrawing()
+    pySIVIA(box, sep, 0.3)
+    vibes.endDrawing()
+
+```
diff --git a/docs/sphinx/_static/css/badge_only.css b/docs/sphinx/_static/css/badge_only.css