Skip to content

docs: Code Coverage badge on the site's home page and a Coverage report tab - #25

Merged
Akinzou merged 1 commit into
masterfrom
docs/site-coverage
Nov 12, 2026
Merged

Akinzou merged 1 commit into
masterfrom
docs/site-coverage

Conversation

@Akinzou

@Akinzou Akinzou commented Nov 12, 2026

Copy link
Copy Markdown
Owner

The docs site now shows the measured coverage like the README: the Code Coverage badge next to the home page title, and a Coverage report tab in the navigation, both opening https://akinzou.github.io/MetaTrader5-Python/coverage/. ADR 0015 and the CHANGELOG are updated.

Verification: pytest (434 passed, 100.00% coverage), check_file_length.py, mkdocs build --strict, check_diagrams.py. The home page was checked in a screenshot.

/code-review high: 6 findings, none breaking. Fixed: documentation of the change (ADR 0015, CHANGELOG) and a comment that now states the decision.

Kept:

  • The badge markdown is the same in README and docs/index.md (two lines). Including it through snippets would split the README title.
  • The report has no link back to the docs: it is coverage.py's generated page.
  • The badge sits in the home page H1, consistent with the owner's choice for the README.

Named debt: the production URL now also appears in docs/index.md and the nav. A domain move must update them together with site_url.

…rt tab

The site now shows the measured coverage like the README does: the badge next
to the home page title, linking to the full report, which also gets a tab in
the navigation.

Chose absolute links over `coverage/` because the report is built next to the
site by the coverage job, not from docs/, and a relative target fails
mkdocs --strict.

Named debt: the production URL now also appears in docs/index.md and the nav.
A move to another domain must update them with site_url; the strict build
reports absolute links only at info level.
@Akinzou
Akinzou merged commit d0ae516 into master Nov 12, 2026
12 checks passed
@Akinzou
Akinzou deleted the docs/site-coverage branch November 14, 2026 01:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant