diff --git a/.gitignore b/.gitignore index cc72c6010..d19f20e9d 100644 --- a/.gitignore +++ b/.gitignore @@ -21,3 +21,4 @@ dask-worker-space .coverage.* *.ipynb **/_version_generated.py +sg_execution_times.rst diff --git a/doc/conf.py b/doc/conf.py index 20cf3780a..c9c7b8561 100644 --- a/doc/conf.py +++ b/doc/conf.py @@ -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), } @@ -102,7 +102,9 @@ # HTML output configuration # ----------------------------------------------------------------------------- html_title = f'{project} {version}' -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 diff --git a/doc/index.rst b/doc/index.rst index e63e87357..80332e664 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -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 @@ -16,19 +23,12 @@ .. raw:: html -
+ .. 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*). diff --git a/env/requirements-docs.txt b/env/requirements-docs.txt index b440bbd9e..333882d2b 100644 --- a/env/requirements-docs.txt +++ b/env/requirements-docs.txt @@ -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 diff --git a/environment.yml b/environment.yml index 3fb56aab5..de90118af 100644 --- a/environment.yml +++ b/environment.yml @@ -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