include nbspinx

Adds ability to parse notebooks directly into documentation
JarronL · Feb 20, 2018 · 30cfc59 · 30cfc59
1 parent 9b805e3
commit 30cfc59
Show file tree

Hide file tree

Showing 7 changed files with 40 additions and 23 deletions.
diff --git a/docs/api/pynrc.obs_coronagraphy.rst → docs/api/pynrc.obs_hci.rst b/docs/api/pynrc.obs_coronagraphy.rst → docs/api/pynrc.obs_hci.rst
@@ -1,32 +1,32 @@
-pynrc.obs_coronagraphy
+pynrc.obs_hci
 ======================
 
 .. currentmodule:: pynrc
 
-.. autoclass:: obs_coronagraphy
+.. autoclass:: obs_hci
    :show-inheritance:
 
    .. rubric:: Attributes Summary
 
    .. autosummary::
 
-      ~obs_coronagraphy.planets
-      ~obs_coronagraphy.wfe_ref_drift
+      ~obs_hci.planets
+      ~obs_hci.wfe_ref_drift
 
    .. rubric:: Methods Summary
 
    .. autosummary::
 
-      ~obs_coronagraphy.add_planet
-      ~obs_coronagraphy.kill_planets
-      ~obs_coronagraphy.calc_contrast
-      ~obs_coronagraphy.gen_offset_psf
-      ~obs_coronagraphy.gen_disk_image
-      ~obs_coronagraphy.gen_planets_image
-      ~obs_coronagraphy.gen_roll_image
-      ~obs_coronagraphy.planet_spec
-      ~obs_coronagraphy.saturation_levels
-      ~obs_coronagraphy.star_flux
+      ~obs_hci.add_planet
+      ~obs_hci.kill_planets
+      ~obs_hci.calc_contrast
+      ~obs_hci.gen_offset_psf
+      ~obs_hci.gen_disk_image
+      ~obs_hci.gen_planets_image
+      ~obs_hci.gen_roll_image
+      ~obs_hci.planet_spec
+      ~obs_hci.saturation_levels
+      ~obs_hci.star_flux
 
    .. rubric:: Methods Documentation
 

diff --git a/docs/conf.py b/docs/conf.py
@@ -38,7 +38,14 @@
     'sphinx.ext.intersphinx',
     'sphinx.ext.inheritance_diagram',
     'sphinx_automodapi.automodapi',
-    'sphinx.ext.napoleon']
+    'sphinx.ext.napoleon',
+    'nbsphinx']
+
+# nbsphinx generates doc files from notebooks on the fly
+# By default, it will execute those notebooks with no outputs.
+# In our case, we plan to upload only pre-executed notebooks.
+# Explicitly turn off execution just in case.
+nbsphinx_execute = 'never'
 
 # Napoleon settings
 napoleon_google_docstring = True
@@ -73,7 +80,7 @@
 
 # General information about the project.
 project = 'pynrc'
-copyright = '2017, Jarron Leisenring'
+copyright = '2018, Jarron Leisenring'
 author = 'Jarron Leisenring'
 
 # The version info for the project you're documenting, acts as replacement for

diff --git a/docs/index.rst b/docs/index.rst
@@ -16,13 +16,13 @@ Documentation for pyNRC (pynrc)
 
    installation.rst
 
-ETC Basic Usage
-
-ETC Advanced Usage
-
-Simulating Observations
-
+.. toctree::
+   :caption: User Guides
+   :maxdepth: 1
 
+   tutorials/Basic_Usage.ipynb   
+   tutorials/Coronagraph_Basics.ipynb
+
 .. toctree::
    :caption: Reference Info
    :maxdepth: 1
@@ -43,5 +43,6 @@ see :ref:`LICENSE <license>`.
 
     If you make use of pyNRC in your work, please cite the following paper: 
     `Leisenring et al. 2018, "pyNRC: A NIRCam ETC and Simulation Toolset"`
+    (in prep).
 
-Copyright (c) 2017 Jarron Leisenring and contributors.
+Copyright (c) 2018 Jarron Leisenring and contributors.
diff --git a/docs/requirements.txt b/docs/requirements.txt
@@ -1,4 +1,7 @@
 sphinx-automodapi
+sphinx>=1.5.1
+ipykernel
+nbsphinx
 numpy
 matplotlib>=2
 Cython

diff --git a/docs/test.rst b/docs/test.rst
@@ -0,0 +1,4 @@
+Coronagraph Test
+=================
+
+../notebooks/Coronagraph_Basics.ipynb
diff --git a/docs/tutorials/Basic_Usage.ipynb b/docs/tutorials/Basic_Usage.ipynb
@@ -0,0 +1 @@
+/Users/jwstnircam/GitHub/pynrc/notebooks/Basic_Usage.ipynb
diff --git a/docs/tutorials/Coronagraph_Basics.ipynb b/docs/tutorials/Coronagraph_Basics.ipynb
@@ -0,0 +1 @@
+/Users/jwstnircam/GitHub/pynrc/notebooks/Coronagraph_Basics.ipynb