docs: Fix ReadTheDocs build by adding configuration file #995
Conversation
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
The documentation at readthedocs.io was stuck at version 0.21.0 from January 2022 due to missing .readthedocs.yaml configuration. This adds proper configuration and fixes documentation warnings that caused strict builds to fail. - Add .readthedocs.yaml to configure Python 3.12 and doc dependencies - Fix RST title level inconsistency in docs/ssh.rst - Remove redundant class annotation in exceptions.py causing duplicate docs warning
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #995 +/- ##
==========================================
- Coverage 73.05% 73.03% -0.02%
==========================================
Files 25 25
Lines 1837 1836 -1
Branches 250 250
==========================================
- Hits 1342 1341 -1
Misses 410 410
Partials 85 85 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
2 tasks
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.
Summary
.readthedocs.yamlconfiguration file to properly build documentation on ReadTheDocsdocs/ssh.rstthat caused Sphinx warningsexceptions.pythat caused duplicate documentation warningsThe documentation at https://aiodocker.readthedocs.io/ has been stuck at version 0.21.0 (from January 2022) because there was no
.readthedocs.yamlconfiguration file. Without this file, ReadTheDocs uses legacy defaults that don't properly install the package with its documentation dependencies.Test plan
uv run sphinx-build -W -E docs docs/_build/htmlbuilds successfully with no warningsuv run mypy aiodocker/exceptions.pypasses