[client-python] chore(docs): fix readthedocs (#69)#215
Open
[client-python] chore(docs): fix readthedocs (#69)#215
Conversation
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #215 +/- ##
=======================================
Coverage 70.41% 70.41%
=======================================
Files 58 58
Lines 2329 2329
=======================================
Hits 1640 1640
Misses 689 689
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
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.
Proposed changes
Fix the ReadTheDocs documentation build and restore working documentation links.
Context
The ReadTheDocs documentation was broken. A new RTD project (openaev-client-for-python) was created and configured to build the docs successfully.
Changes
.readthedocs.yml: Clean up config, remove unnecessary comments and formats: all. Install the package itself (path: .) alongside doc requirements so autoapi can introspect the source.docs/conf.py: Migrate from deprecated autoapi.sphinx to autoapi.extension, configure autoapi_dirs and autoapi_options for proper API reference generation, remove boilerplate comments.docs/requirements.txt: Upgrade dependencies — autoapi2.0.1 → sphinx-autoapi 3.4.0, sphinx 8.2.3 → 9.1.0, sphinx_rtd_theme 3.0.2 → 3.1.0, add astroid 3.3.8.
docs/index.rst: Remove reference to old pyoaev/pyoaev page that no longer exists (now auto-generated by autoapi).README.md: Update API reference link to the new autoapi URL.docs/_static/.gitkeep: Ensure _static directory exists for the build.Working links
Checklist