[ELITERT-1198] Add action to generate the Sphinx doc #2
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
sheputis
reviewed
Oct 30, 2024
.github/workflows/sphinx-doc.yml
Outdated
| branches: [ "master" ] | ||
| pull_request: | ||
| branches: [ "master" ] | ||
| # paths: [ "documentation/**"] |
There was a problem hiding this comment.
i assume you meant to generate the documentation only when doc files are changed? And you had commented this out to test the pipelines?
There was a problem hiding this comment.
Thanks for the review. You were actually too early. I was just testing the action.
There seems to be no easy way to test these things, you just need to crate the action in such a way that it runs for your Pull Requests and when when ready set-up the triggers properly.
sergio-bobillier
force-pushed
the
sb-sphinx-doc
branch
4 times, most recently
from
aeca556 to
04f83ad
Compare
sergio-bobillier
had a problem deploying
to
github-pages
GitHub Actions
Failure
This action is equivalent to the documentation Jenkins job the project used to have. It does the following: * Generates the YARD documentation * Converts the CHANGELOG.md to Sphinx. * Generates the Sphinx documentation. * Uploads the artifact * Deploys the artifact to Github pages. It only does this once changes are merged to master, just like the Jenkins job did.
sergio-bobillier
force-pushed
the
sb-sphinx-doc
branch
from
04f83ad to
06444b4
Compare
sheputis
approved these changes
Oct 30, 2024
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.
This action is equivalent to the documentation Jenkins job the project used to have. It does the following:
CHANGELOG.mdto Sphinx.It only does this once changes are merged to master, just like the Jenkins job did.