diff --git a/docs/conf.py b/docs/conf.py index 1e62bc84..725e2308 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -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) @@ -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", @@ -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'] diff --git a/docs/getting_started/science_spectrum.fits b/docs/getting_started/science_spectrum.fits new file mode 100644 index 00000000..7eaa7c87 Binary files /dev/null and b/docs/getting_started/science_spectrum.fits differ diff --git a/pyproject.toml b/pyproject.toml index 945dd0fe..204cc953 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -24,7 +24,7 @@ test = [ "tox", ] docs = [ - "sphinx-astropy[confv2]", + "sphinx-astropy[confv3]>=1.11", "sphinx-copybutton", "sphinx-design", "matplotlib>=3.7",