docs improvements, including new available_optics page

gabcavic · Jun 23, 2018 · 56287df · 56287df
1 parent ad97f73
commit 56287df
Show file tree

Hide file tree

Showing 7 changed files with 893 additions and 7 deletions.
diff --git a/.rtd-environment.yml b/.rtd-environment.yml
@@ -0,0 +1,13 @@
+name: packagename
+
+channels:
+    - http://ssb.stsci.edu/astroconda
+
+dependencies:
+    - setuptools
+    - numpy
+    - python>=3.0
+    - pip:
+      - sphinx-automodapi
+      - stsci_rtd_theme
+      - nbsphinx
diff --git a/docs/available_optics.ipynb b/docs/available_optics.ipynb
diff --git a/docs/conf.py b/docs/conf.py
@@ -53,6 +53,10 @@
 
 # -- General configuration ----------------------------------------------------
 
+
+extensions.append('nbsphinx')
+extensions.append('sphinx.ext.mathjax')
+
 # By default, highlight as Python 3.
 highlight_language = 'python3'
 
@@ -66,6 +70,8 @@
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.
 exclude_patterns.append('_templates')
+exclude_patterns.append('_build')
+exclude_patterns.append('**.ipynb_checkpoints')
 
 # This is added to the end of RST files - a good place to put substitutions to
 # be used globally.

diff --git a/docs/fresnel.rst b/docs/fresnel.rst
@@ -14,11 +14,9 @@ amplitude aberrations.
 .. caution::
         The Fresnel code has
         been cross-checked against the `PROPER library by John Krist
-        <http://proper-library.sourceforge.net>` to verify accuracy and correctness of
+        <http://proper-library.sourceforge.net>`_ to verify accuracy and correctness of
         output. A test suite is provided along with ``poppy`` in the tests subdirectory
-        and users are encouraged to run these tests themselves. However this is still
-        a relatively new addition to ``poppy``, and it is possible there may still be
-        some bugs.
+        and users are encouraged to run these tests themselves.
 
 
 
@@ -67,7 +65,7 @@ serves the same purpose in Fresnel propagation.  Note that when adding
 function and must specify a physical distance separating that optic from the
 previous optic, again as an `astropy.Quantity
 <http://docs.astropy.org/en/stable/units/>`_ of dimension length. This replaces
-the ``addImage`` and ``addPupil`` methods used in Fraunhofer propagation.
+the ``add_image`` and ``add_pupil`` methods used in Fraunhofer propagation.
 
 
 

diff --git a/docs/index.rst b/docs/index.rst
@@ -56,6 +56,7 @@ Contents
   relnotes.rst
   overview.rst
   examples.rst
+  available_optics.ipynb
   wfe.rst
   coronagraphs.rst
   fresnel.rst

diff --git a/docs/overview.rst b/docs/overview.rst
@@ -34,7 +34,7 @@ Given a specified instrument configuration, an appropriate `~poppy.OpticalSystem
 .. _fraunhofer:
 
 Fraunhofer domain calculations
-================================
+--------------------------------
 
 ``poppy``'s default mode assumes that optical propagation can be modeled using
 Fraunhofer diffraction (the "far field" approximation), such that the
@@ -72,7 +72,7 @@ onto a common pixel scale) more than makes up for this and the MFT is faster.
 
 
 Working with OpticalElements
-===================================
+----------------------------
 
 OpticalElements can be instantiated from FITS files, or created by one of a large number of analytic function definitions implemented as `~poppy.AnalyticOpticalElement` subclasses. 
 Typically these classes take some number of arguments to set their properties. 

diff --git a/readthedocs.yml b/readthedocs.yml
@@ -0,0 +1,7 @@
+conda:
+    file: .rtd-environment.yml
+python:
+    setup_py_install: true
+    version: 3
+formats:
+    - pdf