Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

FIX: fix sphinx-favicon, fix sphinx-extlinks to get readthedocs running #140

Merged
merged 2 commits into from
Oct 25, 2023
Merged

FIX: fix sphinx-favicon, fix sphinx-extlinks to get readthedocs running #140

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3833ead
FIX: use sphinx-favicon
kmuehlbauer Oct 25, 2023
0c82350
FIX: fix extlinks, section-links
kmuehlbauer Oct 25, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 16 additions & 14 deletions docs/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,7 @@
"sphinx.ext.todo",
"myst_parser",
"sphinx_copybutton",
"sphinx_favicon",
"nbsphinx",
]

Expand All @@ -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 = (
Expand Down Expand Up @@ -250,18 +251,6 @@ def _custom_edit_url(
html_theme_options = {
"announcement": "<p>xradar is in an early stage of development, please report any issues <a href='https://github.com/openradar/xradar/issues'>here!</a></p>",
"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",
Expand All @@ -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 ---------------------------------------

Expand Down
2 changes: 1 addition & 1 deletion docs/exporters.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ Exporting is only supported for acknowledged standards.

Currently xradar can export:

- [](#odim_h5)
- [](#odim-h5)
- [](#cfradial2)
- [](#cfradial1)

Expand Down
1 change: 1 addition & 0 deletions docs/history.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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)

Expand Down
4 changes: 2 additions & 2 deletions docs/importers.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
1 change: 1 addition & 0 deletions docs/usage.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
```
1 change: 1 addition & 0 deletions environment.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ dependencies:
- myst-parser
- sphinx
- sphinx-copybutton
- sphinx-favicon
- nbsphinx
- ipykernel
- h5netcdf
Expand Down
Loading