Update versions of Sphinx and its plugins (fatiando#472)

Bump versions of Sphinx and its plugins in `environment.yml` and in `requirements-docs.txt`. Add CSS `dark-light` class to Harmonica logo in the `index.rst` to make its background transparent even in dark mode. Remove Harmonica logo in the left panel.
indiauppal · Mar 27, 2024 · 2d39034 · 2d39034
1 parent eb00981
commit 2d39034
Show file tree

Hide file tree

Showing 5 changed files with 15 additions and 12 deletions.
diff --git a/.gitignore b/.gitignore
@@ -12,6 +12,7 @@ doc/_build
 doc/api/generated
 doc/gallery
 doc/sample_data
+doc/sg_execution_times.rst
 .ipynb_checkpoints
 *.egg-info
 MANIFEST

diff --git a/doc/conf.py b/doc/conf.py
@@ -130,7 +130,9 @@
 # HTML output configuration
 # -----------------------------------------------------------------------------
 html_title = f'{project} <span class="project-version">{version}</span>'
-html_logo = "_static/harmonica-logo.png"
+# Don't use the logo since it gets in the way of the project name and is
+# repeated in the front page.
+# html_logo = "_static/harmonica-logo.png"
 html_favicon = "_static/favicon.png"
 html_last_updated_fmt = "%b %d, %Y"
 html_copy_source = True

diff --git a/doc/index.rst b/doc/index.rst
@@ -21,7 +21,7 @@
 
         .. image:: ./_static/harmonica-logo.svg
             :width: 200px
-            :class: sd-m-auto
+            :class: sd-m-auto dark-light
 
 **Harmonica** is a Python library for processing and modeling gravity and
 magnetic data.

diff --git a/env/requirements-docs.txt b/env/requirements-docs.txt
@@ -1,10 +1,10 @@
 # Documentation building requirements
-sphinx==4.5.*
-sphinx-book-theme==0.2.*
-sphinx-gallery==0.10.*
-sphinx-design==0.2.*
+sphinx==7.2.*
+sphinx-book-theme==1.1.*
+sphinx-gallery==0.15.*
+sphinx-design==0.5.*
 sphinx-copybutton==0.5.*
-jupyter-sphinx==0.4.*
+jupyter-sphinx==0.5.*
 ipykernel
 boule
 pyproj

diff --git a/environment.yml b/environment.yml
@@ -27,12 +27,12 @@ dependencies:
   - coverage
   - boule
   # Documentation requirements
-  - sphinx==4.5.*
-  - sphinx-book-theme==0.2.*
-  - sphinx-gallery==0.10.*
-  - sphinx-design==0.2.*
+  - sphinx==7.2.*
+  - sphinx-book-theme==1.1.*
+  - sphinx-gallery==0.15.*
+  - sphinx-design==0.5.*
   - sphinx-copybutton==0.5.*
-  - jupyter-sphinx==0.4.*
+  - jupyter-sphinx==0.5.*
   - ipykernel
   - pyproj
   - matplotlib