introduced sphinx+doxygen documentation

Author: ebertolazzi

.gitignore

@@ -64,7 +64,6 @@ toolbox/license.txt
 *.mltbx
 *.mexmaci64
 !src_python_interface/include
-docs/xml
-docs/sphinx/splines/*
-!docs/sphinx/splines/.gitkeep
-docs/sphinx/_build
+docs_build/xml
+docs_build/sphinx/api
+docs_build/sphinx/_build

README.md

@@ -1,8 +1,14 @@
-Splines [![Build Status](https://travis-ci.org/ebertolazzi/Splines.svg?branch=master)](https://travis-ci.org/ebertolazzi/Splines) [![View Splines on File Exchange](https://www.mathworks.com/matlabcentral/images/matlab-file-exchange.svg)](https://www.mathworks.com/matlabcentral/fileexchange/54481-splines)
+Splines
 =======
 
+[![Build Status](https://travis-ci.org/ebertolazzi/Splines.svg?branch=master)](https://travis-ci.org/ebertolazzi/Splines)
+[![View Splines on File Exchange](https://www.mathworks.com/matlabcentral/images/matlab-file-exchange.svg)](https://www.mathworks.com/matlabcentral/fileexchange/54481-splines)
 
-`Splines` is a set of C++ classes (with MATLAB mex interface) which implements varios spline interpolation.
+<br>
+
+[Splines](https://github.com/ebertolazzi/Splines) 
+is a set of C++ classes (with MATLAB mex interface) which 
+implements varios spline interpolation.
 The classes are the following:
 
   - ConstantSpline, for piecewise constants functions
@@ -13,19 +19,19 @@ The classes are the following:
   - PchipSpline, 
   - QuinticSpline, Simple quintic spline based on PCHIP
 
-**References**
+### References
 
 - F.N. Fritsch and R.E. Carlson,
-  Monotone Piecewise Cubic Interpolation,
+  Monotone Piecewise Cubic Interpolation,<br>
   SIAM Journal of Numerical Analysis, Vol. 17, No. 2, pp. 238-246,
   April 1980.
 
-**Matlab**
+### Matlab
 
-To use in MATLAB install the toolbox `Splines.mltbx` then compile the files running `CompileSplinesLib`.
+To use in MATLAB install the toolbox `Splines.mltbx` then compile the files running `CompileSplinesLib` (available at [releases](https://github.com/ebertolazzi/Splines/releases))
 
 
-**C++ Usage**
+### C++ Usage
 
 The usage is simple:
 
@@ -92,27 +98,47 @@ cout << spline.DD(1.1) << '\n';  // spline second derivative at x = 1.1
 cout << spline.DDD(1.1) << '\n'; // spline third derivative at x = 1.1
 ~~~~~~~~~~~~~
 
-**Compile and tests**
+### Compile and tests
+
+**Using makefile**
 
 Edit makefile file to match compiler of your OS and do:
 
+```sh
   make
+```
+
+**Using rakefile**
+
+```sh
+  rake build_win    # on windows
+  rake build_linux  # on linux
+  rake build_osx    # on mac
+```
 
 To run the test
 
-  make run
+```sh
+  make run     # using makefile
+  rake run     # using rake on linux and osx
+  rake run_win # using rake on windows
+```
 
-To generate documentation (using DOXYGEN: http://www.stack.nl/~dimitri/doxygen/index.html)
+To generate documentation (using [DOXYGEN](https://www.doxygen.nl/index.html) and [SPHINX](https://www.sphinx-doc.org/en/master/))
 
-make doc
+```sh
+  make doc
+```
 
-**DOXYGEN documentation**
+### Online Documentation
 
-Available at: http://ebertolazzi.github.io/Splines/html/index.html
+Available at: [http://ebertolazzi.github.io/Splines](http://ebertolazzi.github.io/Splines)
 
 * * *
 
 Enrico Bertolazzi<br>
 Dipartimento di Ingegneria Industriale<br>
 Universita` degli Studi di Trento<br>
 email: enrico.bertolazzi@unitn.it
+
+* * *

docs/.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: b1d36ca468536e785b06538e865db08a
+tags: 645f666f9bcd5a90fca523b33c5a78b7

docs/sphinx/_static/.gitkeep docs/.nojekylldocs/sphinx/_static/.gitkeep renamed to docs/.nojekyll

@@ -0,0 +1,25 @@
+.. _exhale_class_class_splines_1_1_akima2_dspline:
+
+Class Akima2Dspline
+===================
+
+- Defined in :ref:`file__Users_enrico_Ricerca_develop_C++_pins-mechatronix_LibSources_submodules_Splines_src_SplineAkima2D.hxx`
+
+
+Inheritance Relationships
+-------------------------
+
+Base Type
+*********
+
+- ``public BiCubicSplineBase`` (:ref:`exhale_class_class_splines_1_1_bi_cubic_spline_base`)
+
+
+Class Documentation
+-------------------
+
+
+.. doxygenclass:: Splines::Akima2Dspline
+   :members:
+   :protected-members:
+   :undoc-members:

docs/_sources/api/class_splines_1_1_akima2_dspline.rst.txt

@@ -0,0 +1,25 @@
+.. _exhale_class_class_splines_1_1_akima_spline:
+
+Class AkimaSpline
+=================
+
+- Defined in :ref:`file__Users_enrico_Ricerca_develop_C++_pins-mechatronix_LibSources_submodules_Splines_src_SplineAkima.hxx`
+
+
+Inheritance Relationships
+-------------------------
+
+Base Type
+*********
+
+- ``public CubicSplineBase`` (:ref:`exhale_class_class_splines_1_1_cubic_spline_base`)
+
+
+Class Documentation
+-------------------
+
+
+.. doxygenclass:: Splines::AkimaSpline
+   :members:
+   :protected-members:
+   :undoc-members:

docs/_sources/api/class_splines_1_1_akima_spline.rst.txt

@@ -0,0 +1,25 @@
+.. _exhale_class_class_splines_1_1_bessel_spline:
+
+Class BesselSpline
+==================
+
+- Defined in :ref:`file__Users_enrico_Ricerca_develop_C++_pins-mechatronix_LibSources_submodules_Splines_src_SplineBessel.hxx`
+
+
+Inheritance Relationships
+-------------------------
+
+Base Type
+*********
+
+- ``public CubicSplineBase`` (:ref:`exhale_class_class_splines_1_1_cubic_spline_base`)
+
+
+Class Documentation
+-------------------
+
+
+.. doxygenclass:: Splines::BesselSpline
+   :members:
+   :protected-members:
+   :undoc-members:

docs/_sources/api/class_splines_1_1_bessel_spline.rst.txt

@@ -0,0 +1,25 @@
+.. _exhale_class_class_splines_1_1_bi_cubic_spline:
+
+Class BiCubicSpline
+===================
+
+- Defined in :ref:`file__Users_enrico_Ricerca_develop_C++_pins-mechatronix_LibSources_submodules_Splines_src_SplineBiCubic.hxx`
+
+
+Inheritance Relationships
+-------------------------
+
+Base Type
+*********
+
+- ``public BiCubicSplineBase`` (:ref:`exhale_class_class_splines_1_1_bi_cubic_spline_base`)
+
+
+Class Documentation
+-------------------
+
+
+.. doxygenclass:: Splines::BiCubicSpline
+   :members:
+   :protected-members:
+   :undoc-members:

docs/_sources/api/class_splines_1_1_bi_cubic_spline.rst.txt

@@ -0,0 +1,32 @@
+.. _exhale_class_class_splines_1_1_bi_cubic_spline_base:
+
+Class BiCubicSplineBase
+=======================
+
+- Defined in :ref:`file__Users_enrico_Ricerca_develop_C++_pins-mechatronix_LibSources_submodules_Splines_src_SplineBiCubic.hxx`
+
+
+Inheritance Relationships
+-------------------------
+
+Base Type
+*********
+
+- ``public SplineSurf`` (:ref:`exhale_class_class_splines_1_1_spline_surf`)
+
+
+Derived Types
+*************
+
+- ``public Akima2Dspline`` (:ref:`exhale_class_class_splines_1_1_akima2_dspline`)
+- ``public BiCubicSpline`` (:ref:`exhale_class_class_splines_1_1_bi_cubic_spline`)
+
+
+Class Documentation
+-------------------
+
+
+.. doxygenclass:: Splines::BiCubicSplineBase
+   :members:
+   :protected-members:
+   :undoc-members:

docs/_sources/api/class_splines_1_1_bi_cubic_spline_base.rst.txt

@@ -0,0 +1,25 @@
+.. _exhale_class_class_splines_1_1_bi_quintic_spline:
+
+Class BiQuinticSpline
+=====================
+
+- Defined in :ref:`file__Users_enrico_Ricerca_develop_C++_pins-mechatronix_LibSources_submodules_Splines_src_SplineBiQuintic.hxx`
+
+
+Inheritance Relationships
+-------------------------
+
+Base Type
+*********
+
+- ``public BiQuinticSplineBase`` (:ref:`exhale_class_class_splines_1_1_bi_quintic_spline_base`)
+
+
+Class Documentation
+-------------------
+
+
+.. doxygenclass:: Splines::BiQuinticSpline
+   :members:
+   :protected-members:
+   :undoc-members: