Skip to content

Update sphinx configuration to use new astropy-unified theme #308

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
hpparvi merged 1 commit into from
May 17, 2026
Merged

Update sphinx configuration to use new astropy-unified theme #308

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 12 additions & 19 deletions docs/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,8 +32,8 @@
from specreduce import __version__

try:
from sphinx_astropy.conf.v2 import * # noqa
from sphinx_astropy.conf.v2 import extensions # noqa
from sphinx_astropy.conf.v3 import * # noqa
from sphinx_astropy.conf.v3 import extensions # noqa
except ImportError:
print("ERROR: the documentation requires the sphinx-astropy package to be installed")
sys.exit(1)
Expand Down Expand Up @@ -96,19 +96,16 @@
html_static_path = ["_static"] # html_theme = None
html_style = "specreduce.css"

html_theme_options.update(
{
"github_url": "https://github.com/astropy/specreduce",
"use_edit_page_button": False,
"navigation_with_keys": False,
"logo": {
"text": f"{project}",
"image_light": "_static/logo_icon.png",
"image_dark": "_static/logo_icon.png",
},
"secondary_sidebar_items": {"**": ["page-toc"], "index": []},
}
)
html_theme_options = {
"github_url": "https://github.com/astropy/specreduce",
"use_edit_page_button": False,
"navigation_with_keys": False,
"logo": {
"image_light": "_static/logo_icon.png",
"image_dark": "_static/logo_icon.png",
},
"secondary_sidebar_items": {"**": ["page-toc"], "index": []},
}

html_context = {
"default_mode": "light",
Expand All @@ -125,10 +122,6 @@
}

# Custom sidebar templates, maps document names to template names.
html_sidebars = {}
html_sidebars['index'] = []
html_sidebars["contributing"] = []

# html_sidebars['**'] = ['localtoc.html']
# html_sidebars['index'] = [] #['globaltoc.html', 'localtoc.html']

Expand Down
Binary file added docs/getting_started/science_spectrum.fits
View file
Open in desktop
Binary file not shown.
2 changes: 1 addition & 1 deletion pyproject.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ test = [
"tox",
]
docs = [
"sphinx-astropy[confv2]",
"sphinx-astropy[confv3]>=1.11",
"sphinx-copybutton",
"sphinx-design",
"matplotlib>=3.7",
Expand Down
Loading