WIP: Add an astropy theme which is a re-configured sunpy-sphinx-theme

pyproject.toml

@@ -37,11 +37,18 @@ confv2 = [
   "pydata-sphinx-theme",
   "sphinx-copybutton",
 ]
+confv3 = [
+  "sunpy-sphinx-theme@git+https://github.com/sunpy/sunpy-sphinx-theme",
+  "sphinx-copybutton",
+]
 all = ["astropy"]
 tests = ["pytest"]
 
 [tool.setuptools.package-data]
 "sphinx_astropy" = ["local/*"]
 
 [tool.setuptools_scm]
-version_file = "sphinx_astropy/version.py"
+version_file = "sphinx_astropy/version.py"
+
+[project.entry-points."sphinx.html_themes"]
+astropy = "sphinx_astropy.conf.v3.theme"

sphinx_astropy/conf/v3/__init__.py

@@ -0,0 +1,12 @@
+# -*- coding: utf-8 -*-
+# Licensed under a 3-clause BSD style license - see LICENSE.rst
+#
+# Astropy shared Sphinx settings.  These settings are shared between
+# astropy itself and affiliated packages.
+#
+# v3 extends v2 to use the shared sunpy-sphinx-theme settings
+
+from sphinx_astropy.conf.v2 import *  # noqa: F403
+
+html_theme = "astropy"
+html_logo = "https://raw.githubusercontent.com/astropy/astropy-logo/refs/heads/main/astropy_logo_notext.svg"

sphinx_astropy/conf/v3/theme/__init__.py

@@ -0,0 +1,15 @@
+from pathlib import Path
+
+from sphinx.application import Sphinx
+
+
+def setup(app: Sphinx):
+    # Register theme
+    theme_dir = Path(__file__).parent.resolve()
+    app.add_html_theme("astropy", theme_dir)
+    app.add_css_file("css/astropy.css", priority=650)
+
+    return {
+        "parallel_read_safe": True,
+        "parallel_write_safe": True,
+    }

sphinx_astropy/conf/v3/theme/static/css/astropy.css

@@ -0,0 +1,12 @@
+:root {
+  /* SunPy Theme Colors */
+  /* If you add or change the names of these please update the docs */
+  --sst-accent-color-bright: #ff5000;
+  --sst-accent-color-muted: #FC9468;
+  --sst-dark-color: #404040;
+  --sst-darker-color: #333333;
+  --sst-darkest-color: #222222;
+  --sst-light-color: rgb(206, 206, 206);
+  --sst-lighter-color: rgb(231, 231, 231);
+  --sst-lightest-color: rgb(251, 251, 251);
+}

sphinx_astropy/conf/v3/theme/theme.toml

@@ -0,0 +1,35 @@
+[theme]
+inherit = "sunpy"
+
+[options]
+sst_project_name = "Astropy"
+sst_site_root = "https://astropy.org"
+navbar_links = [
+    ["About",
+        [
+            ["About Astropy", "about.html", 2],
+            ["Code of Conduct", "code_of_conduct.html", 2],
+            ["Acknowledging & Citing", "acknowledging.html", 2],
+            ["History", "history.html", 2],
+        ]
+    ],
+    ["Documentation",
+        [
+            ["astropy", "https://docs.astropy.org", 3],
+            ["asdf-astropy", "https://asdf-astropy.readthedocs.io", 3],
+            ["astropy-healpix", "https://astropy-healpix.readthedocs.io", 3],
+            ["astroquery", "https://astroquery.readthedocs.io", 3],
+            ["ccdproc", "https://ccdproc.readthedocs.io", 3],
+            ["photutils", "https://photutils.readthedocs.io", 3],
+            ["regions", "https://astropy-regions.readthedocs.io", 3],
+            ["reproject", "https://reproject.readthedocs.io", 3],
+            ["specreduce", "https://specreduce.readthedocs.io", 3],
+            ["specutils", "https://specutils.readthedocs.io", 3],
+        ]
+    ],
+    ["Get Help", "help.html", 2],
+    ["Contribute", "contribute.html", 2],
+    ["Affiliated Packages", "affiliated/index.html", 2],
+    ["Team", "team.html", 2],
+]
+rtd_extra_search_projects = [["astropy-org-test", "https://astropy-org-test.readthedocs.io"]]