Skip to content

Commit

Permalink
switch docs theme to sphinx_rtd, unpin sphinx (#272)
Browse files Browse the repository at this point in the history
  • Loading branch information
braingram authored Aug 29, 2024
2 parents bd5191c + bd72ed5 commit 61ff80a
Show file tree
Hide file tree
Showing 3 changed files with 6 additions and 14 deletions.
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.
17 changes: 5 additions & 12 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -3,21 +3,12 @@
from datetime import datetime
from pathlib import Path

import stsci_rtd_theme

if sys.version_info < (3, 11):
import tomli as tomllib
else:
import tomllib


def setup(app):
try:
app.add_css_file("stsci.css")
except AttributeError:
app.add_stylesheet("stsci.css")


REPO_ROOT = Path(__file__).parent.parent

# Modules that automodapi will document need to be available
Expand Down Expand Up @@ -74,9 +65,11 @@ def setup(app):
numpydoc_show_class_members = False
autoclass_content = "both"

html_theme = "stsci_rtd_theme"
html_theme_options = {"collapse_navigation": True}
html_theme_path = [stsci_rtd_theme.get_html_theme_path()]
html_theme = "sphinx_rtd_theme"
html_logo = "_static/stsci_pri_combo_mark_white.png"
html_theme_options = {
"collapse_navigation": True,
}
html_domain_indices = True
html_sidebars = {"**": ["globaltoc.html", "relations.html", "searchbox.html"]}
html_use_index = True
Expand Down
3 changes: 1 addition & 2 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -35,11 +35,10 @@ file = "LICENSE"
docs = [
"numpydoc",
"packaging >=17",
"sphinx<7.0.0",
"sphinx",
"sphinx-asdf",
"sphinx-astropy",
"sphinx-rtd-theme",
"stsci-rtd-theme",
"tomli; python_version <=\"3.11\"",
]
test = [
Expand Down

0 comments on commit 61ff80a

Please sign in to comment.