FEAT: Use pydata-sphinx-theme

in conf/v2.py
astropy · May 24, 2023 · 238bdab · 238bdab
1 parent 8c4d789
commit 238bdab
Show file tree

Hide file tree

Showing 6 changed files with 418 additions and 5 deletions.
diff --git a/CHANGES.rst b/CHANGES.rst
@@ -4,6 +4,10 @@ Changes in sphinx-astropy
 1.9 (unreleased)
 ----------------
 
+- To switch to ``pydata-sphinx-theme``, use ``sphinx_astropy.conf.v2``.
+  If you still want ``v1``, you have to install ``astropy-sphinx-theme``
+  separately. [#59]
+
 - Update minimum required version of Sphinx to 3.0.0. [#57]
 
 - ``check_sphinx_version`` is deprecated. [#57]

diff --git a/LICENSE.rst b/LICENSE.rst
@@ -1,4 +1,4 @@
-Copyright (c) 2014-2021, Astropy Developers
+Copyright (c) 2014-2023, Astropy Developers
 
 All rights reserved.
 

diff --git a/README.rst b/README.rst
@@ -37,7 +37,9 @@ Installing **sphinx-astropy** will automatically install (if not already present
 
 * `Sphinx <http://www.sphinx-doc.org>`_
 
-* `astropy-sphinx-theme <https://github.com/astropy/astropy-sphinx-theme>`_ - the default 'bootstrap' theme use by Astropy and a number of affilited packages.
+* `pydata-sphinx-theme <https://github.com/pydata/pydata-sphinx-theme/>`_ - a clean, three-column, Bootstrap-based Sphinx theme by and for the `PyData community <https://pydata.org/>`_.
+
+* `sphinx-copybutton <https://github.com/executablebooks/sphinx-copybutton>`_ - a small Sphinx extension to add a "copy" button to code blocks.
 
 * `sphinx-automodapi <http://sphinx-automodapi.readthedocs.io>`_ - an extension that makes it easy to automatically generate API documentation.
 

diff --git a/setup.cfg b/setup.cfg
@@ -21,7 +21,8 @@ python_requires = >=3.7
 install_requires =
     packaging
     sphinx>=3.0.0
-    astropy-sphinx-theme
+    pydata-sphinx-theme
+    sphinx-copybutton
     numpydoc
     sphinx-automodapi
     sphinx-gallery

diff --git a/sphinx_astropy/conf/__init__.py b/sphinx_astropy/conf/__init__.py
@@ -8,7 +8,7 @@
 #
 # or:
 #
-#     from sphinx_astropy.conf.v1 import *
+#     from sphinx_astropy.conf.v2 import *
 #
 # with the latter being the option to use for stability. The idea is that
 # we can still make small changes (mainly fixing bugs) to v1.py, but if we
@@ -17,4 +17,4 @@
 # v2.py file (either starting from a copy of v1.py or starting from
 # scratch), and change the import below to 'from .v2 import *'.
 
-from .v1 import *
+from .v2 import *