Implement a barebones CI for setup for the user docs. #24
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
albu-diku
force-pushed
the
test/docs-build-ci
branch
2 times, most recently
from
06b39e1 to
485a128
Compare
|
This currently fails because the docs do no build cleanly as-is on the main branch. I have opened a pull request to fix the issue: #22. cc @aputtu @SebastianPrehn |
albu-diku
force-pushed
the
test/docs-build-ci
branch
from
485a128 to
810d64c
Compare
|
Unable to build due to https://github.com/ucphhpc/migrid-user-docs/blob/main/docs/sections/shared_content/ucph_login.rst not being included in the tocs. @aputtu Is this meant to replace something, or was it a file to test some features? If the latter, we should probably find some way to store them so that they do not generate warnings |
Add a "build-test" Makefile target which executes a sphinx docs build with warnings turned into errors. Use this new target within a GitHub workflow such that the ability to build the docs is verified on each commit.
albu-diku
force-pushed
the
test/docs-build-ci
branch
from
810d64c to
c887bd4
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Add a "build-test" Makefile target which executes a sphinx docs build with warnings turned into errors. Use this new target within a GitHub workflow such that the ability to build the docs is verified on each commit.