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

Test for building the docs #290

Open
jarlsondre opened this issue Jan 14, 2025 · 0 comments
Open

Test for building the docs #290

jarlsondre opened this issue Jan 14, 2025 · 0 comments
Assignees
Labels
enhancement New feature or request

Comments

@jarlsondre
Copy link
Collaborator

Currently, the docs are often forgotten (at least by myself) when working on features, making our readthedocs page contain errors etc. Therefore, it would be nice to check that the docs build properly whenever we create a pull request. Right now, when we do make http in docs/, it let's us build despite a bunch of warning. However, by adding -W´to SPHINXOPTS, the build will fail if it encounters any errors. Then it should be possible to just add cd docs/ && make clean && make http` to the GitHub Actions to check that the build works.

@jarlsondre jarlsondre added the enhancement New feature or request label Jan 14, 2025
@jarlsondre jarlsondre self-assigned this Jan 14, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant