Automatic docs test #6
Open
Conversation
This file contains 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
Use tox to generate the project documentation in an isolated and reproducible environment. Signed-off-by: Teodora Sechkova <[email protected]>
In order to use GitHub pages to automatically generate documentation from docs, an index file is needed in the root dir. However pdoc generates automatically the index file inside the docs/mcat dir. Add docs/index.html with a simple redirect to docs/mcat/index.html. Signed-off-by: Teodora Sechkova <[email protected]>
Add a new gh actions workflow to automatically build the docs and push them to the repository on each push to main. Signed-off-by: Teodora Sechkova <[email protected]>
Signed-off-by: Teodora Sechkova <[email protected]>
sechkova
force-pushed
the
automatic-docs-test
branch
3 times, most recently
from
99d94ce to
267c72c
Compare
Signed-off-by: Teodora Sechkova <[email protected]>
Signed-off-by: Teodora Sechkova <[email protected]>
sechkova
force-pushed
the
automatic-docs-test
branch
from
6e2a885 to
17e53c4
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.
No description provided.