added tutorials to documentation

BlackHolePerturbationToolkit · Sep 4, 2023 · 20eb66a · 20eb66a
1 parent 7de82d3
commit 20eb66a
Show file tree

Hide file tree

Showing 22 changed files with 1,262 additions and 96 deletions.
diff --git a/docs/environment.yml b/docs/environment.yml
@@ -11,5 +11,4 @@ dependencies:
   - pip
   - python=3.11
   - sphinx-book-theme
-  - nbsphinx
-  - sphinx-autoapi
+  - myst-nb
diff --git a/docs/source/_templates/custom-base-template.rst b/docs/source/_templates/custom-base-template.rst
@@ -0,0 +1,5 @@
+{{ name | escape | underline }}
+
+.. currentmodule:: {{ module }}
+
+.. auto{{ objtype }}:: {{ objname }}
diff --git a/docs/source/_templates/custom-class-template.rst b/docs/source/_templates/custom-class-template.rst
@@ -1,4 +1,4 @@
-{{ fullname | escape | underline}}
+{{ name | escape | underline}}
 
 .. currentmodule:: {{ module }}
 

diff --git a/docs/source/_templates/custom-module-template.rst b/docs/source/_templates/custom-module-template.rst
@@ -1,4 +1,4 @@
-{{ fullname | escape | underline}}
+{{ name | escape | underline}}
 
 .. automodule:: {{ fullname }}
 
@@ -20,6 +20,7 @@
 
    .. autosummary::
       :toctree:
+      :template: custom-base-template.rst
    {% for item in functions %}
       {{ item }}
    {%- endfor %}
@@ -60,7 +61,7 @@
    :template: custom-module-template.rst
    :recursive:
 {% for item in modules %}
-   {{ item }}
+   ~{{ item }}
 {%- endfor %}
 {% endif %}
 {% endblock %}
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -33,8 +33,10 @@
 extensions = [
     "sphinx.ext.autodoc",
     "sphinx.ext.autosummary",
-    "nbsphinx"
+    "myst_nb"
 ]
+myst_enable_extensions = ["dollarmath", "amsmath"]
+nb_execution_mode = "off"
 autosummary_generate = True
 # https://stackoverflow.com/questions/2701998/automatically-document-all-modules-recursively-with-sphinx-autodoc/62613202#62613202
 

diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -18,6 +18,12 @@ The library also provides a set of methods for computing constants of motion and
    :align: right
    :width: 45%
 
+.. note::
+
+   This project is under active development. 
+
+.. _Installation:
+
 Installation
 ------------
 Install the latest version of kerrgeopy using pip
@@ -26,27 +32,42 @@ Install the latest version of kerrgeopy using pip
 
    pip install kerrgeopy
 
-See `Getting Started <notebooks/Tutorial.html>`_ for usage examples.
-
-.. note::
-
-   This project is under active development. The documentation is not yet complete.
+See `Getting Started <notebooks/Tutorial.html>`_ for basic usage. See the `API Reference`_ below or the `Modules <_autosummary/kerrgeopy.html>`_ page for a complete list of classes and methods.
 
 
 .. toctree::
    :maxdepth: 2
    :caption: Tutorials
 
    notebooks/Tutorial
+   notebooks/Trajectory
+   notebooks/Orbital Properties
+   notebooks/Graphics
+
+.. _API Reference:
+
+API Reference
+-------------
+
+.. toctree::
+   :maxdepth: 1
+   :caption: API Reference
+   :hidden:
+
+   Full List of Modules <https://kerrgeopy.readthedocs.io/en/latest/_autosummary/kerrgeopy.html>
 
 .. autosummary::
    :toctree: _autosummary
    :template: custom-module-template.rst
-   :caption: API Reference
    :recursive:
 
-   kerrgeopy
-
+   ~kerrgeopy.bound_orbit.BoundOrbit
+   ~kerrgeopy.plunging_orbit.PlungingOrbit
+   ~kerrgeopy.orbit.Orbit
+   ~kerrgeopy.spacetime.KerrSpacetime
+   ~kerrgeopy.constants
+   ~kerrgeopy.frequencies
+   ~kerrgeopy.units
 
 Indices and tables
 ==================

diff --git a/docs/source/notebooks/Graphics.ipynb b/docs/source/notebooks/Graphics.ipynb