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

Add an action for building the docs #16

Open
ru-fu opened this issue Jun 4, 2024 · 0 comments
Open

Add an action for building the docs #16

ru-fu opened this issue Jun 4, 2024 · 0 comments

Comments

@ru-fu
Copy link
Contributor

ru-fu commented Jun 4, 2024

The docs are built on RTD, so we don't really require a separate check that ensures the docs build correctly - but not everybody has PR reviews enabled.

Also, our first check is currently the spelling check, which builds the docs before checking. With canonical/sphinx-docs-starter-pack#240, we can run the spelling check on existing output, so splitting the spelling check into building + checking the spelling of the existing output should not increase the build times, but make it clearer what is happening.

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

No branches or pull requests

1 participant