docs

kadrlica · Jul 2, 2020 · fd4efbb · fd4efbb
1 parent 879793e
commit fd4efbb
Show file tree

Hide file tree

Showing 3 changed files with 17 additions and 0 deletions.
diff --git a/docs/Makefile b/docs/Makefile
@@ -14,6 +14,10 @@ help:
 
 .PHONY: help Makefile
 
+# Build the notebooks (needs to be better make-ified)
+notebook:
+	jupyter nbconvert --to html --execute --output-dir . ../tutorial/*.ipynb
+
 # Catch-all target: route all unknown targets to Sphinx using the new
 # "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
 %: Makefile

diff --git a/docs/conf.py b/docs/conf.py
@@ -53,3 +53,9 @@
 # relative to this directory. They are copied after the builtin static files,
 # so a file named "default.css" will overwrite the builtin "default.css".
 html_static_path = ['_static']
+
+html_extra_path = ['tutorial1_baseclass.html',
+                   'tutorial2_subclass.html',
+                   'tutorial3_healpix.html',
+                   'tutorial4_decam.html',
+]
diff --git a/docs/index.rst b/docs/index.rst
@@ -10,11 +10,18 @@ Welcome to CartoSky's documentation!
    :maxdepth: 2
    :caption: Contents:
 
+Tutorials
+==================
 
+* `Tutorial 1 <./tutorial1_baseclass.html>`_
+* `Tutorial 2 <./tutorial2_subclass.html>`_
+* `Tutorial 3 <./tutorial3_healpix.html>`_
+* `Tutorial 4 <./tutorial4_decam.html>`_
 
 Indices and tables
 ==================
 
 * :ref:`genindex`
 * :ref:`modindex`
 * :ref:`search`
+