Update RTD page

* Add landing page stub * Add example notebook To be prettified later...
ICB-DCM · Oct 8, 2024 · b81f098 · b81f098
1 parent 6aea82e
commit b81f098
Show file tree

Hide file tree

Showing 6 changed files with 20 additions and 4 deletions.
diff --git a/README.md b/README.md
@@ -6,8 +6,6 @@
 
 Finite difference methods, for applications including gradient computation and gradient checks.
 
-Install with `pip install -e .`.
-
 # Important notes
 The output of your function of interest should be a NumPy array. If your function is scalar-valued, change it to a NumPy array with:
 ```python

diff --git a/doc/about.rst b/doc/about.rst
@@ -0,0 +1,5 @@
+About fiddy
+===========
+
+Fiddy is a Python library implementing finite difference methods,
+for applications including gradient computation and gradient checks.
diff --git a/doc/conf.py b/doc/conf.py
@@ -37,13 +37,18 @@
     "sphinx.ext.napoleon",
     #    "sphinx_autodoc_typehints",  # FIXME fails
     "sphinx.ext.intersphinx",
+    "sphinx.ext.mathjax",
+    "nbsphinx",
+    "IPython.sphinxext.ipython_console_highlighting",
+    "recommonmark",
 ]
 
 intersphinx_mapping = {
     "petab": ("https://petab.readthedocs.io/en/stable/", None),
     "pandas": ("https://pandas.pydata.org/docs/", None),
     "numpy": ("https://numpy.org/devdocs/", None),
     "python": ("https://docs.python.org/3", None),
+    "amici": ("https://amici.readthedocs.io/en/latest/", None),
 }
 
 # sphinx-autodoc-typehints

diff --git a/examples/derivative.ipynb → doc/examples/derivative.ipynb b/examples/derivative.ipynb → doc/examples/derivative.ipynb
@@ -5,6 +5,8 @@
    "id": "1766a5fc",
    "metadata": {},
    "source": [
+    "# Demo\n",
+    "\n",
     "We will approximate the derivative of the Rosenbrock function at `(1,0,0)`, with the forward and backward difference methods, and with two different step sizes.\n",
     "\n",
     "We will also compute an approximation of the central difference, as the average of the forward and backward results.\n",

diff --git a/doc/index.rst b/doc/index.rst
@@ -5,6 +5,8 @@ Welcome to fiddy's documentation!
    :maxdepth: 2
    :caption: Contents:
 
+   about
+   examples/derivative
    modules
 
 Indices and tables

diff --git a/setup.cfg b/setup.cfg
@@ -55,11 +55,15 @@ all =
     %(examples)s
     %(tests)s
 doc =
-    sphinx<8
     docutils<0.19
+    ipython
+    mock
+    nbconvert
+    nbsphinx
+    recommonmark>=0.7.1
+    sphinx<8
     sphinx_rtd_theme
     sphinx-autodoc-typehints
-    mock
     %(amici)s
 amici =
     amici