Skip to content
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

Merged
merged 2 commits into from
Feb 25, 2025
Merged

Fix CI check-docs #1762

merged 2 commits into from
Feb 25, 2025

Conversation

joverlee521
Copy link
Contributor

@joverlee521 joverlee521 commented Feb 20, 2025

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

  • Automated checks pass
  • Check if you need to add a changelog message
  • Check if you need to add tests
  • Check if you need to update docs

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.
Copy link
Contributor

@genehack genehack left a 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

Copy link
Member

@corneliusroemer corneliusroemer left a 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?

@joverlee521
Copy link
Contributor Author

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 devel/regenerate-developer-api-docs to regenerate the docs.

@joverlee521 joverlee521 merged commit bd1eca2 into master Feb 25, 2025
36 checks passed
@joverlee521 joverlee521 deleted the fix-check-docs branch February 25, 2025 18:16
@jameshadfield
Copy link
Member

Would it be a good idea to add checks for Python 3.11 + sphinx-autodoc-typehints v3.1.0 to devel/regenerate-developer-api-docs? I say this as someone who wasn't all that involved in the docs build-chain and finds all the moving parts quite a high barrier to full understanding. The more resilient and fool-proof we can be around docs the easier development on augur is for everyone.

@joverlee521
Copy link
Contributor Author

We can continue discussion around docs development in #1764.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Automated CI failed due to check-docs
4 participants