diff --git a/docs/conf.py b/docs/conf.py index 08daf293..096a39ef 100755 --- a/docs/conf.py +++ b/docs/conf.py @@ -62,6 +62,7 @@ "sphinx.ext.todo", "myst_parser", "sphinx_copybutton", + "sphinx_favicon", "nbsphinx", ] @@ -71,8 +72,8 @@ extlinks = { - "issue": ("https://github.com/openradar/xradar/issues/%s", "GH"), - "pull": ("https://github.com/openradar/xradar/pull/%s", "PR"), + "issue": ("https://github.com/openradar/xradar/issues/%s", "GH %s"), + "pull": ("https://github.com/openradar/xradar/pull/%s", "PR %s"), } mathjax_path = ( @@ -250,18 +251,6 @@ def _custom_edit_url( html_theme_options = { "announcement": "
xradar is in an early stage of development, please report any issues here!
", "github_url": "https://github.com/openradar/xradar", - "favicons": [ - { - "rel": "icon", - "sizes": "16x16", - "href": "openradar_micro.svg", - }, - { - "rel": "icon", - "sizes": "32x32", - "href": "openradar_micro.svg", - }, - ], "icon_links": [ { "name": "PyPI", @@ -284,6 +273,19 @@ def _custom_edit_url( # so a file named "default.css" will overwrite the builtin "default.css". html_static_path = ["_static"] +favicons = [ + { + "rel": "icon", + "sizes": "16x16", + "href": "openradar_micro.svg", + }, + { + "rel": "icon", + "sizes": "32x32", + "href": "openradar_micro.svg", + }, +] + # -- Options for HTMLHelp output --------------------------------------- diff --git a/docs/exporters.md b/docs/exporters.md index fbba992d..fc7f3d09 100644 --- a/docs/exporters.md +++ b/docs/exporters.md @@ -4,7 +4,7 @@ Exporting is only supported for acknowledged standards. Currently xradar can export: -- [](#odim_h5) +- [](#odim-h5) - [](#cfradial2) - [](#cfradial1) diff --git a/docs/history.md b/docs/history.md index 72bdc128..87890337 100644 --- a/docs/history.md +++ b/docs/history.md @@ -3,6 +3,7 @@ ## Development version (unreleased) * FIX: Add history to cfradial1 output, and fix minor error in CfRadial1_Export.ipynb notebook({pull}`132`) by [@syedhamidali](https://github.com/syedhamidali) +* FIX: fix readthedocs build for python 3.12 ({pull}`140`) by [@kmuehlbauer](https://github.com/kmuehlbauer). ## 0.4.0 (2023-09-27) diff --git a/docs/importers.md b/docs/importers.md index 75f17e41..f87c0eae 100644 --- a/docs/importers.md +++ b/docs/importers.md @@ -5,11 +5,11 @@ To import different radar data different approaches are used. Currently xradar can import: - [](#cfradial1) -- [](#odim_h5) +- [](#odim-h5) - [](#gamic-hdf5) - [](#furuno-scn-and-scnx) - [](#rainbow) -- [](#irissigmet) +- [](#iris-sigmet) ## CfRadial1 diff --git a/docs/usage.md b/docs/usage.md index 4005cf93..e554fe51 100644 --- a/docs/usage.md +++ b/docs/usage.md @@ -36,4 +36,5 @@ notebooks/Read-plot-Sigmet-data-from-AWS notebooks/plot-ppi notebooks/angle_reindexing notebooks/Multi-Volume-Concatenation.ipynb +notebooks/multiple-sweeps-into-volume-scan.ipynb ``` diff --git a/environment.yml b/environment.yml index 18b0d9fc..43fe0fc8 100644 --- a/environment.yml +++ b/environment.yml @@ -9,6 +9,7 @@ dependencies: - myst-parser - sphinx - sphinx-copybutton + - sphinx-favicon - nbsphinx - ipykernel - h5netcdf