From 49a3613c4aa1df6151542662910e51246d320f59 Mon Sep 17 00:00:00 2001 From: Brandon Dube Date: Mon, 20 Aug 2018 22:17:07 -0400 Subject: [PATCH] + TOC user guide on index --- docs/source/index.rst | 8 +++++++- docs/source/user_guide/psfs.rst | 4 ++++ docs/source/user_guide/pupils.rst | 4 ++++ docs/source/user_guide/zernikes.rst | 4 ++++ 4 files changed, 19 insertions(+), 1 deletion(-) diff --git a/docs/source/index.rst b/docs/source/index.rst index 69240314..48c450b1 100644 --- 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 index 4828599a..7d19d78a 100644 --- 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 index 7ea010cf..2eff50ab 100644 --- 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 index e5ca27fa..fd7ee10e 100644 --- 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__`;