* fix(docs): repair Sphinx build configuration
The autodoc2 package path still …pointed at the pre-src-layout location
(../wetterdienst), so the entire API reference rendered empty. Point it at
../src/wetterdienst and resolve the follow-on warnings:
- read project metadata via importlib.metadata instead of tomllib, so the
build also works on Python 3.10 (tomllib is 3.11+, but the project targets
3.10+)
- reference leaf modules in library/core.md instead of the wetterdienst.model
package, which emitted a broken sub-toctree
- keep the auto-generated apidocs tree out of the build and suppress the benign
autodoc2 duplicate-object warnings from provider re-exports
- enable useful MyST extensions, heading anchors, copybutton prompt stripping
and a longer notebook execution timeout for remote data cells
- drop stale poetry-era comments from .readthedocs.yml and gitignore the
generated docs/apidocs tree
Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
* docs: correct outdated and inaccurate content
- overview.md: add the five missing providers (AEMET, CHMI, FMI, KNMI, SMHI),
fix leftover broken RST links, the duplicated NOAA name, the stale "ISD" note
(it is GHCNh now) and the informal NWS wording
- data/index.md: drop the toctree entry for a station_history.md that does not
exist under data/ (it lives under usage/)
- docker.md: remove the documented `wetterdienst explorer` command, which does
not exist in the CLI
- python-examples.md: fix the MOSMIX-LARGE cell reusing an undefined `request`
variable, which silently showed SMALL data
- settings.md: fix "switch of caching" typo
- development.md: correct the test marker (`explorer`, not `ui`), reference ruff
instead of black, and fix wording/typos
Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
* docs: add quickstart, interpolation/summary and climate stripes pages
- quickstart.md: install to first request (stations + values) with the CLI
equivalent and onward links
- interpolation.md: dedicated Interpolation & Summary chapter, moving the
content out of the oversized python-api.md and adding the previously
undocumented CLI and REST usage; fix the settings field name
(ts_geo_station_distance, not ts_interpolation_station_distance)
- stripes.md: document the climate/warming-stripes feature (CLI + REST), which
had no documentation despite being the README centerpiece
- station_history.md: fix the `src.wetterdienst` imports and document the
`wetterdienst history` CLI command
- python-api.md: promote the mis-nested Caching/FSSPEC sections and link the new
interpolation chapter
- index.md: wire the new pages into the usage navigation
Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
* docs: flesh out thin provider intro pages
Eight provider index pages (AEMET, CHMI, DMI, FMI, KNMI, MET Norway, RMI, SMHI)
were only a title plus a toctree, and NOAA had an empty Overview and no License
section. Bring them up to the same baseline as the other providers with an
Overview describing the coverage/resolutions and authentication requirements,
and a License section linking the relevant source and attribution terms. All
authentication details (WD_AUTH__* variables) and licenses were verified against
the provider code.
Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
* docs: fill in thin network-level provider overviews
Five network-level index pages (eaufrance/hubeau, eccc/observation,
geosphere/observation, imgw/hydrology, imgw/meteorology) had an empty Overview
section. Add an overview describing the coverage, resolutions, access mechanism,
authentication and notable quirks for each, matching the level of detail of the
other network pages (e.g. rmi/observation). Details were verified against the
provider code (endpoints, GeoJSON/CSV/zip formats, latin-1 encoding, IMGW
archive layout, Hubeau real-time window).
Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
* docs(dwd): review and improve the DWD data pages
- dwd/index.md: add the missing Road network to the overview, correct the stale
"derived" summary (it lists only monthly heating degree days, but many
products across hourly/daily/monthly are supported), clarify the Mosmix/DMO
descriptions, and link each product to its sub-page
- dwd/road/index.md: replace the three-bullet stub with a proper overview
(motorway stations, 15-minute BUFR data, station list, no auth)
- dwd/observation/index.md: fix the VISBILITY -> VISIBILITY dataset typo and
replace the broken `wetterdienst dwd about fields` CLI examples (no `dwd`
subcommand exists) with the verified `DwdObservationRequest.describe_fields`
Python helper
Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
* ci(docs): drop the vestigial setuptools upgrade from the RTD build
The build backend is `uv_build`, so nothing in the docs install chain uses
setuptools; the `pip install --upgrade setuptools` step was a leftover from the
old poetry/setuptools setup. The remaining `uv sync` (via install.sh) is still
required because the docs build imports the installed package.
Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
* ci(docs): move the RTD install into the install job and bump to ubuntu-24.04
The dependency install ran in `post_install` (a hook that fires after the
install phase); move it into the `install` job where it semantically belongs.
Behaviour is unchanged: `uv sync --active` still installs into RTD's virtualenv
so the default Sphinx build (HTML and PDF) finds the dependencies. Also bump the
build image to ubuntu-24.04.
Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
* ci(docs): build the docs on Python 3.14
Match the RTD build Python to the version the project's CI runs on (3.14), which
is also the latest classifier the project advertises. The heavy docs extras
(scipy, wradlib, shapely) are already exercised on 3.14 in CI.
Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
---------
Co-authored-by: Claude Opus 4.8 <noreply@anthropic.com>