Skip to content

[client-python] chore(docs): fix readthedocs (#69)#215

Merged
ncarenton merged 1 commit intomainfrom
fix-readthedocs
May 5, 2026
Merged

[client-python] chore(docs): fix readthedocs (#69)#215
ncarenton merged 1 commit intomainfrom
fix-readthedocs

Conversation

@ncarenton
Copy link
Copy Markdown
Member

@ncarenton ncarenton commented Apr 30, 2026

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 — autoapi
    2.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

  • I consider the submitted work as finished
  • I tested the code for its functionality
  • I wrote test cases for the relevant uses case
  • I added/update the relevant documentation
  • Where necessary I refactored code to improve the overall quality
  • For bug fix → I implemented a test that covers the bug

@ncarenton ncarenton linked an issue Apr 30, 2026 that may be closed by this pull request
@github-actions github-actions Bot added the filigran team use to identify PR from the Filigran team label Apr 30, 2026
@ncarenton ncarenton changed the title [client-python] chore(docs): fix readthedocs [client-python] chore(docs): fix readthedocs (#69) Apr 30, 2026
@codecov
Copy link
Copy Markdown

codecov Bot commented Apr 30, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 70.06%. Comparing base (58abf4c) to head (ae61bfb).
⚠️ Report is 2 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main     #215      +/-   ##
==========================================
- Coverage   70.41%   70.06%   -0.35%     
==========================================
  Files          58       49       -9     
  Lines        2329     1941     -388     
==========================================
- Hits         1640     1360     -280     
+ Misses        689      581     -108     
Flag Coverage Δ
connectors 70.06% <ø> (-0.35%) ⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

Comment thread docs/conf.py
@ncarenton ncarenton force-pushed the fix-readthedocs branch 3 times, most recently from 3a47631 to 2a94d6a Compare May 5, 2026 13:22
Copy link
Copy Markdown
Member

@guzmud guzmud left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@ncarenton ncarenton requested a review from guzmud May 5, 2026 13:33
@ncarenton ncarenton merged commit 8dfc6ff into main May 5, 2026
12 checks passed
@ncarenton ncarenton deleted the fix-readthedocs branch May 5, 2026 13:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

filigran team use to identify PR from the Filigran team

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Documentation should be up to date on readthedocs

2 participants