Merge branch 'dev'

.travis.yml

@@ -103,7 +103,7 @@ matrix:
         - sudo apt-get -y install flex bison || true
         - sudo apt-get -y install doxygen graphviz || true
         #
-        #sudo apt-get -y install python3-pip python3-setuptools python3-wheel python3-breathe
+        #sudo apt-get -y install python3-pip python3-setuptools python3-wheel python3-breathe sphinx-issues
         #sudo pip3 install --upgrade pip
         #sudo pip3 install --upgrade pyIbex
         #
@@ -211,7 +211,7 @@ matrix:
       env: CMAKE_PARAM_G="Visual Studio 16" CMAKE_PARAM_A=x64 CFG=x64_vc16 CPCFG=-win_amd64 PY_V_F=3.8.3 PY_V_MDM=3.8 PY_V_MM=38
       before_install: 
         - choco install -y visualstudio2019buildtools visualstudio2019-workload-vctools winflexbison
-        - cmd //c "choco install -y doxygen.install graphviz & choco install -y python --version=${PY_V_F} & refreshenv.cmd & set PATH=C:\Python${PY_V_MM};C:\Python${PY_V_MM}\Scripts;%PATH% & python -m pip install --upgrade pip & pip install --upgrade pyIbex & pip install --upgrade wheel setuptools & git clone -b v3.1.1 ttps://github.com/sphinx-doc/sphinx & cd sphinx & pip install . & pip install --upgrade breathe sphinx-tabs sphinx_rtd_theme & refreshenv.cmd"
+        - cmd //c "choco install -y doxygen.install graphviz & choco install -y python --version=${PY_V_F} & refreshenv.cmd & set PATH=C:\Python${PY_V_MM};C:\Python${PY_V_MM}\Scripts;%PATH% & python -m pip install --upgrade pip & pip install --upgrade pyIbex & pip install --upgrade wheel setuptools & git clone -b v3.1.1 ttps://github.com/sphinx-doc/sphinx & cd sphinx & pip install . & pip install --upgrade breathe sphinx-issues sphinx-tabs sphinx_rtd_theme & refreshenv.cmd"
         - export PATH=/c/Python${PY_V_MM}:/c/Python${PY_V_MM}/Scripts:$PATH
       cache:
         directories: ibex
@@ -270,7 +270,7 @@ matrix:
       env: CMAKE_PARAM_G="Visual Studio 15" CMAKE_PARAM_A=x64 CFG=x64_vc15 CPCFG=m-win_amd64 PY_V_F=3.7.7 PY_V_MDM=3.7 PY_V_MM=37
       before_install: 
         - choco install -y winflexbison
-        - cmd //c "choco install -y doxygen.install graphviz & choco install -y python --version=${PY_V_F} & refreshenv.cmd & set PATH=C:\Python${PY_V_MM};C:\Python${PY_V_MM}\Scripts;%PATH% & python -m pip install --upgrade pip & pip install --upgrade pyIbex & pip install --upgrade wheel setuptools & git clone -b v3.1.1 ttps://github.com/sphinx-doc/sphinx & cd sphinx & pip install . & pip install --upgrade breathe sphinx-tabs sphinx_rtd_theme & refreshenv.cmd"
+        - cmd //c "choco install -y doxygen.install graphviz & choco install -y python --version=${PY_V_F} & refreshenv.cmd & set PATH=C:\Python${PY_V_MM};C:\Python${PY_V_MM}\Scripts;%PATH% & python -m pip install --upgrade pip & pip install --upgrade pyIbex & pip install --upgrade wheel setuptools & git clone -b v3.1.1 ttps://github.com/sphinx-doc/sphinx & cd sphinx & pip install . & pip install --upgrade breathe sphinx-issues sphinx-tabs sphinx_rtd_theme & refreshenv.cmd"
         - export PATH=/c/Python${PY_V_MM}:/c/Python${PY_V_MM}/Scripts:$PATH
       cache:
         directories: ibex
@@ -304,7 +304,7 @@ matrix:
       env: CMAKE_PARAM_G="Visual Studio 14" CMAKE_PARAM_A=Win32 CFG=x86_vc14 CPCFG=m-win32 PY_V_F="3.6.8 --x86" PY_V_MDM=3.6 PY_V_MM=36
       before_install: 
         - choco install -y vcbuildtools -ia "/InstallSelectableItems Win81SDK_CppBuildSKUV1;VisualCppBuildTools_ATLMFC_SDK" winflexbison
-        - cmd //c "choco install -y doxygen.install graphviz & choco install -y python --version=${PY_V_F} & refreshenv.cmd & set PATH=C:\Python${PY_V_MM};C:\Python${PY_V_MM}\Scripts;%PATH% & python -m pip install --upgrade pip & pip install --upgrade pyIbex & pip install --upgrade wheel setuptools & git clone -b 3.1.1 https://github.com/sphinx-doc/sphinx & cd sphinx & pip install . & pip install --upgrade breathe sphinx-tabs sphinx_rtd_theme & refreshenv.cmd"
+        - cmd //c "choco install -y doxygen.install graphviz & choco install -y python --version=${PY_V_F} & refreshenv.cmd & set PATH=C:\Python${PY_V_MM};C:\Python${PY_V_MM}\Scripts;%PATH% & python -m pip install --upgrade pip & pip install --upgrade pyIbex & pip install --upgrade wheel setuptools & git clone -b 3.1.1 https://github.com/sphinx-doc/sphinx & cd sphinx & pip install . & pip install --upgrade breathe sphinx-issues sphinx-tabs sphinx_rtd_theme & refreshenv.cmd"
         - export PATH=/c/Python${PY_V_MM}:/c/Python${PY_V_MM}/Scripts:$PATH
       cache:
         directories: ibex
@@ -362,7 +362,7 @@ matrix:
       env: CMAKE_PARAM_G="Visual Studio 14" CMAKE_PARAM_A=x64 CFG=x64_vc14 CPCFG=m-win_amd64 PY_V_F=3.6.8 PY_V_MDM=3.6 PY_V_MM=36
       before_install: 
         - choco install -y vcbuildtools -ia "/InstallSelectableItems Win81SDK_CppBuildSKUV1;VisualCppBuildTools_ATLMFC_SDK" winflexbison
-        - cmd //c "choco install -y doxygen.install graphviz & choco install -y python --version=${PY_V_F} & refreshenv.cmd & set PATH=C:\Python${PY_V_MM};C:\Python${PY_V_MM}\Scripts;%PATH% & python -m pip install --upgrade pip & pip install --upgrade pyIbex & pip install --upgrade wheel setuptools & git clone -b v3.1.1 ttps://github.com/sphinx-doc/sphinx & cd sphinx & pip install . & pip install --upgrade breathe sphinx-tabs sphinx_rtd_theme & refreshenv.cmd"
+        - cmd //c "choco install -y doxygen.install graphviz & choco install -y python --version=${PY_V_F} & refreshenv.cmd & set PATH=C:\Python${PY_V_MM};C:\Python${PY_V_MM}\Scripts;%PATH% & python -m pip install --upgrade pip & pip install --upgrade pyIbex & pip install --upgrade wheel setuptools & git clone -b v3.1.1 ttps://github.com/sphinx-doc/sphinx & cd sphinx & pip install . & pip install --upgrade breathe sphinx-issues sphinx-tabs sphinx_rtd_theme & refreshenv.cmd"
         - export PATH=/c/Python${PY_V_MM}:/c/Python${PY_V_MM}/Scripts:$PATH
       cache:
         directories: ibex
@@ -396,7 +396,7 @@ matrix:
       env: CMAKE_PARAM_G="Visual Studio 14" CMAKE_PARAM_A=x64 CFG=x64_vc14 CPCFG=m-win_amd64 PY_V_F=3.5.4.20200110 PY_V_MDM=3.5 PY_V_MM=35
       before_install: 
         - choco install -y vcbuildtools -ia "/InstallSelectableItems Win81SDK_CppBuildSKUV1;VisualCppBuildTools_ATLMFC_SDK" winflexbison
-        - cmd //c "choco install -y doxygen.install graphviz & choco install -y python --version=3.5.4.20200110 & refreshenv.cmd & set PATH=C:\Python${PY_V_MM};C:\Python${PY_V_MM}\Scripts;%PATH% & python -m pip install --upgrade pip & pip install --upgrade pyIbex & pip install --upgrade wheel setuptools & git clone -b 3.1.1 https://github.com/sphinx-doc/sphinx & cd sphinx & pip install . & pip install --upgrade breathe sphinx-tabs sphinx_rtd_theme & refreshenv.cmd"
+        - cmd //c "choco install -y doxygen.install graphviz & choco install -y python --version=3.5.4.20200110 & refreshenv.cmd & set PATH=C:\Python${PY_V_MM};C:\Python${PY_V_MM}\Scripts;%PATH% & python -m pip install --upgrade pip & pip install --upgrade pyIbex & pip install --upgrade wheel setuptools & git clone -b 3.1.1 https://github.com/sphinx-doc/sphinx & cd sphinx & pip install . & pip install --upgrade breathe sphinx-issues sphinx-tabs sphinx_rtd_theme & refreshenv.cmd"
         - export PATH=/c/Python35:/c/Python35/Scripts:$PATH
       cache:
         directories: ibex
@@ -526,7 +526,7 @@ install:
   # For documentation
   - sudo apt-get install python3.5 python3-setuptools python3-pip
   - sudo update-alternatives --install /usr/bin/python python /usr/bin/python3.5 1 # using python3 as default version
-  - sudo python3 -m pip install sphinx_rtd_theme breathe sphinx-tabs
+  - sudo python3 -m pip install sphinx_rtd_theme breathe sphinx-issues sphinx-tabs
   - sudo apt-get install python3-sphinx doxygen graphviz
 
   # For Python wrapping

CHANGELOG

@@ -0,0 +1,209 @@
+Unreleased yet (in development)
+===============================
+
+.. Features added
+.. --------------
+.. 
+.. Changes
+.. -------
+.. 
+.. Dependencies
+.. ------------
+
+.. Bugs fixed
+.. ----------
+
+.. Deprecated
+.. ----------
+
+Documentation
+-------------
+
+* added the FAQ page
+
+
+-----------------------------------------------------------------
+
+Release 3.0.9 (released `Jun 28, 2020 <https://github.com/SimonRohou/tubex-lib/releases/tag/v3.0.9>`_)
+======================================================================================================
+
+`Commits since previous release 3.0.8 <https://github.com/SimonRohou/tubex-lib/compare/v3.0.8...v3.0.9>`_
+
+Bugs fixed
+----------
+
+* :commit:`26bce8a2f7f2e0077a128c296332b6e326fa6381`: ``Trajectory::make_continuous()``, error encountered in *datasso*
+* :commit:`33f3b0db2b3995e18e62316632ccf5a87f6dd2da`: corrected bug in ``RandTrajectory``
+
+Documentation
+-------------
+
+* added this changelog page
+
+
+-----------------------------------------------------------------
+
+Releases 3.0.6 -- 3.0.8 (released `Jun 23, 2020 <https://github.com/SimonRohou/tubex-lib/releases/tag/v3.0.8>`_)
+================================================================================================================
+
+`Commits since previous release 3.0.5 <https://github.com/SimonRohou/tubex-lib/compare/v3.0.5...v3.0.8>`_
+
+Features added
+--------------
+
+* added new contractor ``CtcLinobs``
+* :commit:`5d7be8a`: predefined value ``oo`` for infinity in C++ (already exists in Python)
+* :commit:`92dae58`: added ``Figure::view_box()`` Python binding
+* :commit:`2c882a2`: drawing polygons
+* Compatibilities with Windows OS (improving compatibilities with macOS)
+
+Changes
+-------
+
+* :commit:`075104a`: Python binding, ``TubeVector``, removing default value ``n`` in constructor
+
+Bugs fixed
+----------
+
+* :commit:`be1c4b5`: ``RandTrajectory``, values were outside bounds
+* :commit:`6f78d94`: added *Linobs* example
+* :commit:`e19f459`: ``CtcDeriv``, restoring performances of V2 (polygons)
+
+Documentation
+-------------
+
+* Lessons E and F
+* Install page: Windows/Python
+* ``VIBesFigTube``
+* updated docstring from XML script
+* how to concatenate two boxes
+
+
+-----------------------------------------------------------------
+
+Release 3.0.5 (released `Jun 14, 2020 <https://github.com/SimonRohou/tubex-lib/releases/tag/v3.0.5>`_)
+======================================================================================================
+
+`Commits since previous release 3.0.4 <https://github.com/SimonRohou/tubex-lib/compare/v3.0.4...v3.0.5>`_
+
+Changes
+-------
+
+* :commit:`962c219`: renaming from ``input2index()`` to ``time_to_index()``
+* revising whole Python binding
+* :commit:`e0a6c64`: ``CtcEval``, removing ``contract()`` methods with const args
+
+Bugs fixed
+----------
+
+* :commit:`79fd1f4`: ``VIBesFig::draw_pie``: corrected bug in case of ``r.lb() == 0``
+* :commit:`6febe83`: fixing *datasso* example in Python
+* :commit:`193bc95` fixing ``Tools::rand_in_bounds()``
+
+Documentation
+-------------
+
+* Lesson C
+* inverting ``py`` and ``cpp`` tabs in the manual
+* added docstring from XML script
+
+
+-----------------------------------------------------------------
+
+Release 3.0.4 (released `Jun 10, 2020 <https://github.com/SimonRohou/tubex-lib/releases/tag/v3.0.4>`_)
+======================================================================================================
+
+`Commits since previous release 3.0.3 <https://github.com/SimonRohou/tubex-lib/compare/v3.0.3...v3.0.4>`_
+
+Features added
+--------------
+
+* :commit:`40a8ea6`: Python binding, ``abs()`` for any type
+
+Documentation
+-------------
+
+* updated Lessons A and B
+* table in Install pages with configurations
+
+
+-----------------------------------------------------------------
+
+Release 3.0.3 (released `Jun 7, 2020 <https://github.com/SimonRohou/tubex-lib/releases/tag/v3.0.3>`_)
+======================================================================================================
+
+`Commits since previous release 3.0.2 <https://github.com/SimonRohou/tubex-lib/compare/v3.0.2...v3.0.3>`_
+
+Changes
+-------
+
+* :commit:`10110d5`: optimizing add of ``CtcDeriv`` in CN
+
+Bugs fixed
+----------
+
+* :commit:`5934513`: ``VIBesFigMap``, do not crash in case of empty observations
+
+
+-----------------------------------------------------------------
+
+Release 3.0.2 (released `Jun 6, 2020 <https://github.com/SimonRohou/tubex-lib/releases/tag/v3.0.2>`_)
+======================================================================================================
+
+`Commits since previous release 3.0.1 <https://github.com/SimonRohou/tubex-lib/compare/v3.0.1...v3.0.2>`_
+
+Changes
+-------
+
+* :commit:`b1dcd55`: updated arithmetic for Python binding
+* :commit:`1b7e4f9`: using ``BoolInterval`` in Python scripts
+
+Documentation
+-------------
+
+* updated Lessons A and B
+* Install page: Windows/Python
+* :commit:`5e3555d`: spell checking
+
+
+-----------------------------------------------------------------
+
+Release 3.0.1 (released `Jun 5, 2020 <https://github.com/SimonRohou/tubex-lib/releases/tag/v3.0.1>`_)
+======================================================================================================
+
+`Commits since previous release 3.0.0 <https://github.com/SimonRohou/tubex-lib/compare/v3.0.0-beta5...v3.0.1>`_
+
+Features added
+--------------
+
+* :commit:`16408f9`: shortcut ``oo`` available in tubex module
+* :commit:`67b1709`: Tubex available online with Python
+
+Dependencies
+------------
+
+* :commit:`fedbdb0`: pyibex 1.8.1 at least
+* :commit:`e6adc26`: using version 2.5.0 of pybind11
+
+Bugs fixed
+----------
+
+* :commit:`c8063dd`: ``VIBesFig``, display a point if ``box.max_diam() == 0``
+
+Documentation
+-------------
+
+* updated Lessons A and B
+* ``CtcDist``, ``CtcFunction`` doc
+
+
+-----------------------------------------------------------------
+
+Previous versions
+=================
+
+The changelog for versions before 3.0.1 can be found `on GitHub history <https://github.com/SimonRohou/tubex-lib/commits/master>`_.
+
+* **v3.0** (released `Jun 3, 2020 <https://github.com/SimonRohou/tubex-lib/releases/tag/v3.0.0-beta5>`_)
+* **v2.0** (released `Aug 12, 2019 <https://github.com/SimonRohou/tubex-lib/releases/tag/v2.0.0>`_)
+* **v1.0** (released `May 5, 2017 <https://github.com/SimonRohou/tubex-lib/releases/tag/v1.0.0>`_)

doc/doc/_static/custom-sphinx.css

@@ -72,7 +72,7 @@
 
   div.document a:visited
   {
-    color: #3091d1;
+    color: #2980B9;
   }
 
 
@@ -119,3 +119,11 @@
   {
     margin-bottom: 0;
   }
+
+/* Removes space in lists */
+
+.rst-content .section ol p, .rst-content .section ul p
+{
+  margin-bottom: 0;
+  margin-top: 3px;
+}

doc/doc/conf.py.in

@@ -37,7 +37,8 @@ extensions = [
     'sphinx.ext.githubpages',
     'sphinx.ext.napoleon',
     'sphinx_tabs.tabs',
-    'breathe'
+    'breathe',
+    'sphinx_issues'
     #'sphinx.ext.autodoc'
 ]
 
@@ -51,6 +52,14 @@ rst_prolog = """
   :class: underline
 """
 
+# GitHub repo
+issues_github_path = "SimonRohou/tubex-lib"
+
+# equivalent to
+issues_uri = "https://github.com/SimonRohou/tubex-lib/issues/{issue}"
+issues_pr_uri = "https://github.com/SimonRohou/tubex-lib/pull/{pr}"
+issues_commit_uri = "https://github.com/SimonRohou/tubex-lib/commit/{commit}"
+
 numfig = True
 
 # mathjax_path = "https://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML"

doc/doc/api_technical_doc.rst → doc/doc/dev/api_technical_doc.rst

@@ -4,4 +4,4 @@
 C++ API technical documentation
 ###############################
 
-The `C++ API technical documentation <../api/html/annotated.html>`_ of the library is available.
+The `C++ API technical documentation <../../api/html/annotated.html>`_ of the library is available.

doc/doc/dev/changelog.rst

@@ -0,0 +1,13 @@
+.. _sec-changelog:
+
+:tocdepth: 1
+
+.. default-role:: any
+
+.. _changes:
+
+=========
+Changelog
+=========
+
+.. include:: ../../../CHANGELOG

doc/doc/manual/10-dev/index.rst → doc/doc/dev/info_dev.rst

@@ -100,7 +100,7 @@ Build this user manual using Sphinx:
 .. code-block:: bash
 
   # Install Sphinx with
-  pip3 install -U sphinx breathe sphinx_rtd_theme sphinx-tabs
+  pip3 install -U sphinx breathe sphinx_rtd_theme sphinx-tabs sphinx-issues
 
   # Build the doc
   cd build