Merge pull request #242 from tBuLi/sphinx_notebook

Notebooks in documentation
tBuLi · Jun 6, 2019 · 4b5932c · 4b5932c
2 parents e030a01 + 565cfb5
commit 4b5932c
Show file tree

Hide file tree

Showing 11 changed files with 1,030 additions and 56 deletions.
diff --git a/.readthedocs.yml b/.readthedocs.yml
@@ -0,0 +1,23 @@
+# .readthedocs.yml
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# Required
+version: 2
+
+# Build documentation in the docs/ directory with Sphinx
+sphinx:
+  configuration: docs/conf.py
+
+# Optionally build your docs in additional formats such as PDF and ePub
+formats: all
+
+# Optionally set the version of Python and requirements required to build your docs
+python:
+  version: 3.7
+  install:
+    - requirements: requirements_docs.txt
+    - method: pip
+      path: .
+      extra_requirements:
+        - all
diff --git a/.travis.yml b/.travis.yml
@@ -41,8 +41,12 @@ jobs:
 
     - stage: docs
       python: "3.7"
+      addons:
+        apt:
+          packages:
+            - pandoc
       install:
-        - pip install --upgrade sphinx
+        - pip install --upgrade -r requirements_docs.txt
         - pip install --upgrade .[all]
       script: 
         - mkdir docs_build

diff --git a/docs/conf.py b/docs/conf.py
@@ -35,6 +35,7 @@
     'sphinx.ext.mathjax',
     'sphinx.ext.viewcode',
     'sphinx.ext.intersphinx',
+    'nbsphinx',
 ]
 
 intersphinx_mapping = {
@@ -54,6 +55,9 @@
     ('py:func', 'symfit.core.leastsqbound.leastsqbound')
 ]
 
+# Always re-execute notebooks when building the docs
+nbsphinx_execute = 'always'
+
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ['_templates']
 

diff --git a/docs/examples/ex_bivariate_likelihood.ipynb b/docs/examples/ex_bivariate_likelihood.ipynb
diff --git a/docs/examples/ex_bivariate_likelihood.rst b/docs/examples/ex_bivariate_likelihood.rst
diff --git a/docs/examples/ex_mexican_hat.ipynb b/docs/examples/ex_mexican_hat.ipynb
diff --git a/docs/examples/ex_ode_system.ipynb b/docs/examples/ex_ode_system.ipynb
diff --git a/docs/examples/ex_tikhonov.ipynb b/docs/examples/ex_tikhonov.ipynb
diff --git a/docs/examples/index.rst b/docs/examples/index.rst
@@ -17,7 +17,9 @@ paper.
     ex_piecewise
     ex_poly_surface_fit
     ex_ODEModel
+    ex_ode_system.ipynb
     ex_CallableNumericalModel
+    ex_tikhonov.ipynb
 
 Objective Examples
 ------------------
@@ -28,7 +30,16 @@ standard least-squares objective, such as likelihood fitting.
 .. toctree::
     :maxdepth: 1
 
-    ex_bivariate_likelihood
+    ex_bivariate_likelihood.ipynb
+
+Minimizer Examples
+------------------
+These examples demonstrate the different minimizers available in ``symfit``.
+
+.. toctree::
+    :maxdepth: 1
+
+    ex_mexican_hat.ipynb
 
 Interactive Guess Module
 ------------------------
@@ -43,4 +54,4 @@ initial values.
 
     ex_interactive_guesses_ODE
     ex_interactive_guesses_vector_2D
-    ex_interactive_guesses_nD
+    ex_interactive_guesses_nD
diff --git a/examples/bivariate_likelihood.py b/examples/bivariate_likelihood.py
diff --git a/requirements_docs.txt b/requirements_docs.txt
@@ -0,0 +1,5 @@
+-r requirements.txt
+sphinx
+nbsphinx
+IPython
+ipykernel