-
Notifications
You must be signed in to change notification settings - Fork 130
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Fix CI check-docs #1762
Fix CI check-docs #1762
Conversation
Regenerate the developer API documentation after creating a new venv with Python 3.11 and installed the latest dependencies. This will fix the CI/check-docs job, but seems very finicky from the dev experience.
Use explicit Python version to match the Python version used in .readthedocs.yml since the different Python version leads to different versions of sphinx dependencies that can change the auto-generated docs.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
boy howdy that's a whole lotta churn
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks! IIUC this now orders the declarations alphabetically? So hopefully this won't change again later?
Merging for now since it'll fix CI. The finicky dev experience I'm talking about is all dev's local environment must be using Python 3.11 + sphinx-autodoc-typehints v3.1.0 to keep the docs consistent when running |
Would it be a good idea to add checks for Python 3.11 + sphinx-autodoc-typehints v3.1.0 to |
We can continue discussion around docs development in #1764. |
Description of proposed changes
Regenerate the developer API documentation after creating a new venv
with Python 3.11 and installed the latest dependencies.
This will fix the CI/check-docs job, but seems very finicky from the
dev experience.
Related issue(s)
Resolves #1761
Checklist