FEAT: Use pydata-sphinx-theme in conf/v2.py (#59)

* FEAT: Use pydata-sphinx-theme
in conf/v2.py

* Update changelog_links.py

* Fix globaltoc settings
and moved custom.css stuff downstream.

Customize copy button to not copy code
prompt or output.

Misc v2 fixes.

* Dial it down from 11
by not introducing breaking change to the status quo.
Also remove deprecated function from v2.

* Add v2 to CI

* Add test for v2

* Remove main index sidebar
because it is repetitive

---------

Co-authored-by: Kyle Sunden <[email protected]>

Author: pllim

.github/workflows/python-tests.yml

@@ -32,16 +32,19 @@ jobs:
           - os: ubuntu-latest
             python-version: "3.11"
             toxenv: py311-test-sphinx60
+          - os: ubuntu-latest
+            python-version: "3.11"
+            toxenv: py311-test-v2deps-sphinx70
           - os: macos-latest
             python-version: "3.11"
             toxenv: py311-test-sphinxdev
 
     steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v3
       with:
         fetch-depth: 0
     - name: Set up Python ${{ matrix.python-version }}
-      uses: actions/setup-python@v2
+      uses: actions/setup-python@v4
       with:
         python-version: ${{ matrix.python-version }}
     - name: Install Tox

CHANGES.rst

@@ -4,6 +4,9 @@ Changes in sphinx-astropy
 1.9 (unreleased)
 ----------------
 
+- To switch to ``pydata-sphinx-theme``, use ``sphinx_astropy.conf.v2``
+  and install the ``[v2]`` optional dependencies. [#59]
+
 - Update minimum required version of Sphinx to 3.0.0. [#57]
 
 - ``check_sphinx_version`` is deprecated. [#57]

LICENSE.rst

@@ -1,4 +1,4 @@
-Copyright (c) 2014-2021, Astropy Developers
+Copyright (c) 2014-2023, Astropy Developers
 
 All rights reserved.
 

README.rst

@@ -37,7 +37,7 @@ 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.
+* `astropy-sphinx-theme <https://github.com/astropy/astropy-sphinx-theme>`_ - the default 'bootstrap' theme use by Astropy and a number of affiliated packages. This goes with `sphinx_astropy.conf.v1`.
 
 * `sphinx-automodapi <http://sphinx-automodapi.readthedocs.io>`_ - an extension that makes it easy to automatically generate API documentation.
 
@@ -49,3 +49,19 @@ Installing **sphinx-astropy** will automatically install (if not already present
   images, used by some examples in the astropy core documentation.
 
 * `pytest-doctestplus <https://github.com/astropy/pytest-doctestplus/>`_ - providing the 'doctestplus' extension to skip code snippets in narrative documentation.
+
+pydata-sphinx-theme (v2)
+^^^^^^^^^^^^^^^^^^^^^^^^
+
+To use the new `pydata-sphinx-theme` with `sphinx_astropy.conf.v2`, you have to install
+the optional `[v2]` dependencies::
+
+    pip install sphinx-astropy[v2]
+
+That would pull in the following as well:
+
+* `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.

setup.cfg

@@ -30,6 +30,9 @@ install_requires =
     pytest-doctestplus>=0.11
 
 [options.extras_require]
+v2 =
+    pydata-sphinx-theme
+    sphinx-copybutton
 all = astropy
 tests = pytest
 

sphinx_astropy/conf/__init__.py

@@ -17,4 +17,5 @@
 # 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 *
+# TODO: Switch default to v2
+from .v1 import *  # noqa: F401, F403