more nbs for docs

README.md

@@ -74,11 +74,13 @@ Notes:
 
 ## Dev Guide - Adding notebooks to Read The Docs
 
-- Copy notebook into `docs/notebooks` (N.B. the notebook must have at least one section header and be using the "Python 3 (ipykernel)" kernel, not some conda env kernel that may only be installed locally)
+- Copy notebook into `docs/notebooks` (N.B. the notebook must have at least one section header* and be using the "Python 3 (ipykernel)" kernel, not some conda env kernel that may only be installed locally)
 - Update the toctree in the file `docs/notebooks.rst`
 - Ensure necessary requirements are declared in `pyproject.toml` and `docs/requirements.txt`. Also, make sure that the notebook being added to the docs is using the python3 (ipykernel) kernel, not some conda env kernel that may only be installed locally
 - To update the docs locally, from the `docs` dir run: `python -m sphinx -T -E -b html -d _build/doctrees -D language=en . ../_readthedocs/html`
 
+* Multiple section headers from a notebook will also show up in the table of contents.
+
 ## Dev Guide - Updating pyproject.toml
 
 If you are adding code that requires a new dependency, this needs to be included in pyproject.toml under the `[project]' section:

docs/index.rst

@@ -5,6 +5,11 @@
 Welcome to adler's documentation!
 ========================================================================================
 
+Introduction
+------------
+
+Adler is an open source package which provides tools for detecting and characterising activity in observations of solar system objects.
+
 Dev Guide - Getting Started
 ---------------------------
 

docs/notebooks.rst

@@ -5,3 +5,6 @@ Notebooks
 
     Introducing Jupyter Notebooks <notebooks/intro_notebook>
     Adler phasecurve models <notebooks/adler_phasecurve_example>
+    Adler plotting example <notebooks/plotting_utilities_example>
+    Adler outlier detection <notebooks/outlier_detection_example>
+    Adler colour measurement <notebooks/colour_functions_example>