openego / eDisGo / 23282907181

84%

Build Type

push

github

Committed by web-flow

Commit Message

fix Docs link check fails (#604)

* fix: update Zenodo link and fix doc linkcheck CI failures

Three issues caused the docs linkcheck CI job to fail:

1. Outdated Zenodo link (records/890479, ~2017) returned 403 Forbidden
   in CI. Updated to the current Ding0 dataset (records/10405129) in
   both doc/quickstart.rst and examples/edisgo_simple_example.ipynb.

2. numpy.org sporadically returns incomplete responses in CI
   (Zstandard data is incomplete). Added linkcheck_retries = 3 in
   doc/conf.py to handle these transient failures without ignoring
   the link entirely.

3. The linkcheck_ignore list previously included other URLs that fail
   in CI for the same reason (e.g. stackoverflow, gurobi). This
   pattern is now consistently applied only where necessary.

* fix: ignore zenodo.org and numpy.org in linkcheck

Both domains consistently return errors in CI (zenodo: 403 Forbidden,
numpy: Zstandard data is incomplete) even though the links are valid.
Added both to linkcheck_ignore, consistent with the existing pattern
for stackoverflow, gurobi, and other CI-inaccessible domains.

* fix: update OpenEnergy DataBase links, ego-n project website link and demandlib references in documentation and code

fix: 5xE501 and two F841 flake8 errors

* fix: remove special-members option from autoapi and update documentation index

* fix: resolve duplicate object warnings and block quote error in docs

- Set autoapi_own_page_level to "class" so each class gets its own page,
  preventing duplicate py:attribute registrations
- Add logging filter in setup() to suppress residual duplicate object
  description warnings from autoapi/Napoleon interaction
- Fix $HOME$ in Config docstring (replaced with ~/.edisgo) to avoid RST
  parse error
- Add explicit "API Reference" label for autoapi toctree entry
- Restore show-module-summary in autoapi_options

* fix: read Sphinx version dynamically from package metadata (#606)

The version in doc/conf.py was hardcoded to "0.2.1" wh... (continued)

Run Details

13 of 18 new or added lines in 3 files covered. (72.22%)

1 existing line in 1 file now uncovered.

8573 of 10251 relevant lines covered (83.63%)

0.84 hits per line