Clean documentation cross references#354
Merged
Merged
Conversation
why: Remove broken and duplicate documentation targets so Sphinx builds cleanly and first mentions resolve to useful destinations. what: - Qualify the rendered logging.Logger API reference - Avoid duplicate argparse section labels in CLI docs - Link first mentions and normalize shell command examples
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #354 +/- ##
=======================================
Coverage 91.06% 91.06%
=======================================
Files 9 9
Lines 347 347
=======================================
Hits 316 316
Misses 31 31 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
why: Give the documentation cleanup a user-facing unreleased changelog item and keep the rendered migration page linked to the changelog. what: - Add a high-level documentation entry for clearer links and copyable examples - Point the migration notes at the existing changelog page label
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
1 participant
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.
Summary
logging.LoggerAPI reference in rendered docs.Testing
rm -rf docs/_build; uv run ruff check . --fix --show-fixes; uv run ruff format .; uv run mypy .; uv run py.test --reruns 0 -vvv; just build-docs