+ TOC user guide on index

brandondube · Aug 21, 2018 · 49a3613 · 49a3613
1 parent f18eea3
commit 49a3613
Show file tree

Hide file tree

Showing 4 changed files with 19 additions and 1 deletion.
diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -1,5 +1,6 @@
+*****
 prysm
-=====
+*****
 :Release: |release|
 :Date: |today|
 
@@ -108,6 +109,11 @@ Parsing Data from Commercial Instruments
 User's Guide
 ------------
 
+.. toctree::
+   :maxdepth: 1
+   :glob:
+
+   user_guide/*
 
 Developer Guide
 ---------------

diff --git a/docs/source/user_guide/psfs.rst b/docs/source/user_guide/psfs.rst
@@ -1,3 +1,7 @@
+****
+PSFs
+****
+
 PSFs in prysm have a very simple constructor;
 
 >>> import numpy as np

diff --git a/docs/source/user_guide/pupils.rst b/docs/source/user_guide/pupils.rst
@@ -1,3 +1,7 @@
+******
+Pupils
+******
+
 Most any physical optics model begins with a description of a wave at a pupil plane.  This page will cover the core functionality of pupils; each analytical variety has its own documentation.
 
 

diff --git a/docs/source/user_guide/zernikes.rst b/docs/source/user_guide/zernikes.rst
@@ -1,3 +1,7 @@
+********
+Zernikes
+********
+
 Prysm supports two flavors of Zernike polynomials; the Fringe set up to the 49th term, and the Zemax Standard set up to the 48th term.  They have identical interfaces, so only one will be shown here.
 
 Zernike notations are a subclass of :class:`Pupil`, so they support the same arguments to :code:`__init__`;
-Original file line number
+Diff line change
@@ -1,3 +1,7 @@
+    ******
+    Pupils
+    ******
     Most any physical optics model begins with a description of a wave at a pupil plane.  This page will cover the core functionality of pupils; each analytical variety has its own documentation.
@@ Expand Down @@