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

Regenerate docs on pre-commit. #1418

Merged
merged 2 commits into from
Jun 29, 2024
Merged

Regenerate docs on pre-commit. #1418

merged 2 commits into from
Jun 29, 2024

Conversation

fnando
Copy link
Member

@fnando fnando commented Jun 28, 2024

What

Regenerate docs on pre-commit.

Why

Right now, the full docs file is only regenerated before pushing changes, which requires you to be aware and do another commit with the changes. We should do it before commiting, so you only have to do it once.

Known limitations

N/A

@fnando fnando requested a review from willemneal June 28, 2024 17:26
Copy link
Member

@willemneal willemneal left a comment

Choose a reason for hiding this comment

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

I think we should use a docs branch and have CI build this. It's annoying that this is a blocker in CI.

@willemneal willemneal merged commit 2755d68 into main Jun 29, 2024
24 of 25 checks passed
@willemneal willemneal deleted the pre-commit-docs branch June 29, 2024 23:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

2 participants