Use PyData theme for docs (#485)

jakirkham · web-flow · commit 45a8ef3cea0e · 2023-10-28T02:30:26.000Z
* Require `pydata-sphinx-theme` in `docs`

* Configure `pydata_sphinx_theme` in docs

* Note PyData theme change
diff --git a/docs/conf.py b/docs/conf.py
@@ -132,7 +132,7 @@ def __getattr__(cls, name):
 
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
-html_theme = 'default'
+html_theme = 'pydata_sphinx_theme'
 
 # Theme options are theme-specific and customize the look and feel of a theme
 # further.  For a list of options available for each theme, see the
diff --git a/docs/release.rst b/docs/release.rst
@@ -14,6 +14,9 @@ Unreleased
 Enhancements
 ~~~~~~~~~~~~
 
+* Use PyData theme for docs
+  By :user:`John Kirkham <jakirkham>`, :issue:`485`.
+
 Fix
 ~~~
 
diff --git a/pyproject.toml b/pyproject.toml
@@ -47,6 +47,7 @@ Homepage = "https://github.com/zarr-developers/numcodecs"
 docs = [
     "sphinx<7.0.0",
     "sphinx-issues",
+    "pydata-sphinx-theme",
     "numpydoc",
     "mock",
 ]

Original file line number	Diff line number	Diff line change
`@@ -47,6 +47,7 @@ Homepage = "https://github.com/zarr-developers/numcodecs"`
`47`	`47`	`docs = [`
`48`	`48`	`"sphinx<7.0.0",`
`49`	`49`	`"sphinx-issues",`
	`50`	`+ "pydata-sphinx-theme",`
`50`	`51`	`"numpydoc",`
`51`	`52`	`"mock",`
`52`	`53`	`]`