Repository navigation
docs: Code Coverage badge on the site's home page and a Coverage report tab - #25
Merged
Merged
Conversation
…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.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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:
docs/index.md(two lines). Including it through snippets would split the README title.Named debt: the production URL now also appears in
docs/index.mdand the nav. A domain move must update them together withsite_url.