Skip to content

Commit

Permalink
Update the versions of documentation tools
Browse files Browse the repository at this point in the history
Use the newest sphinx, themes, plugins. Had to make some adjustments to
the front page in order to adapt to the new versions.
  • Loading branch information
leouieda committed Feb 5, 2024
1 parent a5a4992 commit 81e651e
Show file tree
Hide file tree
Showing 5 changed files with 30 additions and 27 deletions.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -21,3 +21,4 @@ dask-worker-space
.coverage.*
*.ipynb
**/_version_generated.py
sg_execution_times.rst
12 changes: 7 additions & 5 deletions doc/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -42,14 +42,14 @@
# functions/classes
intersphinx_mapping = {
"python": ("https://docs.python.org/3/", None),
"numpy": ("https://docs.scipy.org/doc/numpy/", None),
"scipy": ("https://docs.scipy.org/doc/scipy/reference", None),
"numpy": ("https://numpy.org/doc/stable/", None),
"scipy": ("https://docs.scipy.org/doc/scipy/", None),
"sklearn": ("https://scikit-learn.org/stable/", None),
"pandas": ("https://pandas.pydata.org/pandas-docs/stable/", None),
"xarray": ("https://xarray.pydata.org/en/stable/", None),
"xarray": ("https://docs.xarray.dev/en/stable/", None),
"cartopy": ("https://scitools.org.uk/cartopy/docs/latest/", None),
"pooch": ("https://www.fatiando.org/pooch/latest/", None),
"matplotlib": ("https://matplotlib.org/", None),
"matplotlib": ("https://matplotlib.org/stable/", None),
"dask": ("https://docs.dask.org/en/latest/", None),
"pygmt": ("https://www.pygmt.org/latest/", None),
}
Expand Down Expand Up @@ -102,7 +102,9 @@
# HTML output configuration
# -----------------------------------------------------------------------------
html_title = f'{project} <span class="project-version">{version}</span>'
html_logo = "_static/verde-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/verde-logo.png"
html_favicon = "_static/favicon.png"
html_last_updated_fmt = "%b %d, %Y"
html_copy_source = True
Expand Down
16 changes: 8 additions & 8 deletions doc/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,13 @@
:margin: 5 5 0 0
:padding: 0 0 0 0

.. grid-item::
:columns: 12 4 12 4

.. image:: ./_static/verde-logo.svg
:width: 200px
:class: sd-m-auto dark-light

.. grid-item::
:columns: 12 8 12 8

Expand All @@ -16,19 +23,12 @@

.. raw:: html

<h1 class="display-1"><img src="_static/verde-title.svg" alt="Verde"></h1>
<h1 class="display-1"><img class="dark-light" src="_static/verde-title.svg" alt="Verde"></h1>

.. div:: sd-fs-3

Processing and gridding spatial data, machine-learning style

.. grid-item::
:columns: 12 4 12 4

.. image:: ./_static/verde-logo.svg
:width: 200px
:class: sd-m-auto

**Verde** is a Python library for processing spatial data (bathymetry,
geophysics surveys, etc) and interpolating it on regular grids (i.e.,
*gridding*).
Expand Down
14 changes: 7 additions & 7 deletions env/requirements-docs.txt
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
sphinx==4.5.*
sphinx-book-theme==0.3.*
sphinx-gallery==0.10.*
sphinx==7.2.*
sphinx-book-theme==1.1.*
sphinx-gallery==0.15.*
sphinx-copybutton==0.5.*
sphinx-design==0.1.*
matplotlib==3.5.*
sphinx-design==0.5.*
matplotlib==3.8.*
cartopy>=0.20
pyproj
pygmt==0.6.*
gmt==6.3.*
pygmt==0.11.*
gmt==6.5.*
ipython
14 changes: 7 additions & 7 deletions environment.yml
Original file line number Diff line number Diff line change
Expand Up @@ -20,21 +20,21 @@ dependencies:
- pykdtree
- numba
# Test
- matplotlib==3.5.*
- matplotlib==3.8.*
- cartopy>=0.20
- pytest
- pytest-cov
- pytest-mpl
- coverage
# Documentation
- sphinx==4.5.*
- sphinx-book-theme==0.3.*
- sphinx-gallery==0.10.*
- sphinx==7.2.*
- sphinx-book-theme==1.1.*
- sphinx-gallery==0.15.*
- sphinx-copybutton==0.5.*
- sphinx-design==0.1.*
- sphinx-design==0.5.*
- pyproj
- pygmt==0.6.*
- gmt==6.3.*
- pygmt==0.11.*
- gmt==6.5.*
- ipython
# Style
- black
Expand Down

0 comments on commit 81e651e

Please sign in to comment.