Skip to content

Commit

Permalink
switch to sphinx rtd theme (#8224)
Browse files Browse the repository at this point in the history
  • Loading branch information
braingram authored Jan 30, 2024
1 parent bddb39c commit 5dfb515
Show file tree
Hide file tree
Showing 4 changed files with 8 additions and 9 deletions.
2 changes: 2 additions & 0 deletions CHANGES.rst
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,8 @@ documentation
- Updated installation instructions to include a warning that Python<=3.11
must be used. [#8200]

- Change docs theme to ``sphinx-rtd-theme`` [#8224]

emicorr
-------

Expand Down
Binary file added docs/_static/stsci_pri_combo_mark_white.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
14 changes: 6 additions & 8 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,6 @@
from configparser import ConfigParser

import sphinx
import stsci_rtd_theme

from stpipe import Step
from sphinx.ext.autodoc import AttributeDocumenter
Expand Down Expand Up @@ -55,10 +54,6 @@ def add_content(self, more_content):


def setup(app):
try:
app.add_css_file("stsci.css")
except AttributeError:
app.add_stylesheet("stsci.css")
# add a custom AttributeDocumenter subclass to handle Step.spec formatting
app.add_autodocumenter(StepSpecDocumenter, True)

Expand Down Expand Up @@ -260,22 +255,25 @@ def check_sphinx_version(expected_version):

# 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 = '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 = {
"collapse_navigation": True
"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 = [stsci_rtd_theme.get_html_theme_path()]
#html_theme_path = []

# The name for this set of Sphinx documents. If None, it defaults to
# "<project> v<release> documentation".
Expand Down
1 change: 0 additions & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -125,7 +125,6 @@ docs = [
"sphinx-astropy",
"sphinx-automodapi",
"sphinx-rtd-theme",
"stsci-rtd-theme",
"tomli; python_version <\"3.11\"",
]
sdp = [
Expand Down

0 comments on commit 5dfb515

Please sign in to comment.