Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
16 changes: 7 additions & 9 deletions .readthedocs.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -14,16 +14,14 @@ build:
os: ubuntu-24.04
tools:
python: "3.13"
jobs:
create_environment:
- asdf plugin add uv
- asdf install uv latest
- asdf global uv latest
install:
- UV_PROJECT_ENVIRONMENT=$READTHEDOCS_VIRTUALENV_PATH uv sync --no-default-groups --group docs

# Build documentation in the "docs/" directory with Sphinx
sphinx:
configuration: docs/conf.py
# Optionally, but recommended,
# declare the Python requirements required to build your documentation
# See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
python:
install:
- method: pip
path: .
extra_requirements:
- docs
3 changes: 3 additions & 0 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -96,6 +96,9 @@
}

html_theme = "pydata_sphinx_theme"
html_theme_options = {
"header_links_before_dropdown": 4,
}

html_static_path = ["_static"]
html_css_files = ["custom.css"]
Expand Down
5 changes: 3 additions & 2 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -28,8 +28,9 @@ User Guide
:maxdepth: 1

Examples <examples/solar_wind_example>
Changelog <changelog>
Contributing Guide <CONTRIBUTING>

Complete OMNI variables <omni_variables>
SuperMAG electrojet indices <supermag_indices>
SuperMAG substorm-onset catalogues <supermag_substorms>
Changelog <changelog>
Contributing Guide <CONTRIBUTING>
15 changes: 0 additions & 15 deletions docs/requirements.txt

This file was deleted.

16 changes: 14 additions & 2 deletions pyproject.toml
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
# SPDX-FileCopyrightText: 2025 GFZ Helmholtz Centre for Geosciences
#
# SPDX-License-Identifier: Apache-2.0
Expand Down Expand Up @@ -47,11 +47,10 @@
"wget>=3.2",
"xarray>=2024.10",
]
dynamic = ["optional-dependencies", "version"]
dynamic = ["version"]

[tool.setuptools.dynamic]
version = { attr = "swvo.__version__" }
optional-dependencies.docs = { file = ["docs/requirements.txt"] }

[project.urls]
Homepage = "https://github.com/GFZ/SWVO"
Expand Down Expand Up @@ -137,3 +136,16 @@
"pytest>=9.0.2",
"pytest-mock>=3.15.1",
]
docs = [
"sphinx-copybutton",
"sphinx-github-changelog",
"sphinx",
"pydata-sphinx-theme",
"myst-parser",
"alabaster",
"docutils",
"imagesize",
"numpydoc",
"linkify-it-py",
"nbsphinx",
]
1 change: 0 additions & 1 deletion swvo.def
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,6 @@ From: astral/uv:python3.12-bookworm-slim
swvo /opt/swvo/
pyproject.toml /opt/swvo/
uv.lock /opt/swvo/
docs/requirements.txt /opt/swvo/docs/requirements.txt
download_daily_files.py /opt/swvo/

%environment
Expand Down
51 changes: 25 additions & 26 deletions uv.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading