Skip to content

Commit

Permalink
great big docs update, including converging usage.rst to .ipynb
Browse files Browse the repository at this point in the history
  • Loading branch information
mperrin committed Aug 28, 2024
1 parent 8c246c9 commit 14e5baa
Show file tree
Hide file tree
Showing 5 changed files with 1,452 additions and 311 deletions.
42 changes: 35 additions & 7 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -83,17 +83,18 @@
"numpydoc",
]


if on_rtd:
extensions.append('sphinx.ext.mathjax')

numpydoc_show_class_members = False

autosummary_generate = True
graphviz_dot = "dot"
# Add any paths that contain templates here, relative to this directory.
templates_path = ["_templates"]

# The suffix(es) of source filenames.
# You can specify multiple suffix as a list of string:
#
# source_suffix = ['.rst', '.md']
# The suffix of source filenames.
source_suffix = ".rst"

# The master toctree document.
Expand Down Expand Up @@ -131,13 +132,40 @@

# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
html_theme = "stsci_rtd_theme"
html_theme_path = [stsci_rtd_theme.get_html_theme_path()]
html_theme = "sphinx_rtd_theme"

# Theme options are theme-specific and customize the look and feel of a theme
# further. For a list of options available for each theme, see the
# documentation.
# html_theme_options = {}
html_theme_options = {
"collapse_navigation": True,
"sticky_navigation": False,
# "nosidebar": "false",
# "sidebarbgcolor": "#4db8ff",
# "sidebartextcolor": "black",
# "sidebarlinkcolor": "black",
# "headbgcolor": "white",
}

html_logo = '_static/stsci_pri_combo_mark_white.png'

# Add any paths that contain custom themes here, relative to this directory.
#html_theme_path = []

# The name for this set of Sphinx documents. If None, it defaults to
# "<project> v<release> documentation".
# html_title = None

# A shorter title for the navigation bar. Default is the same as html_title.
# html_short_title = None

# The name of an image file (relative to this directory) to place at the top
# of the sidebar.

# The name of an image file (within the static path) to use as favicon of the
# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
# pixels large.
# html_favicon = None

# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
Expand Down
2 changes: 1 addition & 1 deletion docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ Contents
intro.rst
installation.rst
relnotes.rst
usage.rst
usage.ipynb
psf_grids.rst

.. toctree::
Expand Down
4 changes: 0 additions & 4 deletions docs/relnotes.rst
Original file line number Diff line number Diff line change
Expand Up @@ -14,11 +14,7 @@ See https://github.com/spacetelescope/webbpsf/issues for currently open issues a
the pupil entrance aperture in the discrete Fourier transform. If you need
accurate PSF information at such large radii, please contact Marshall Perrin
or Marcio Melendez for higher resolution pupil data.

**The following factors are NOT included in these simulations:**

* Coronagraphic masks are assumed to be perfect (i.e. the masks exactly match their design parameters.)
* Most detector effects, such as intrapixel sensitivity variations or interpixel capacitance. There are currently no plans to include these WebbPSF itself. Generate a subsampled PSF and use a separate detector model code instead. The one exception is a scattering artifact in the MIRI imager detector substrate.

------------------

Expand Down
1,269 changes: 1,269 additions & 0 deletions docs/usage.ipynb

Large diffs are not rendered by default.

446 changes: 147 additions & 299 deletions notebooks/WebbPSF_tutorial.ipynb

Large diffs are not rendered by default.

0 comments on commit 14e5baa

Please sign in to comment.