CI: Add workflow for documentation generation #40
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
d3zd3z
force-pushed
the
docgen
branch
10 times, most recently
from
fb808dd to
0aa7b96
Compare
d3zd3z
force-pushed
the
docgen
branch
5 times, most recently
from
8f7655f to
fd3147d
Compare
|
I tried to add a workflow to update the status to give a link to the generated documentation, but that doesn't seem to have permission to run. We can figure out if there is a way to do that. For now, you can view the generated docs here. |
Ablu
approved these changes
Dec 12, 2024
.github/workflows/docs.yml
Outdated
|
|
||
| jobs: | ||
| generate-docs: | ||
| runs-on: ubuntu-latest |
There was a problem hiding this comment.
I would consider pinning this to a specific version to avoid surprises.
Add a target to the build `rustdoc` that will generate the rust documentation. The documentation will be placed in a target-specific directory under `build/rust/target/...`. There is some duplication in the cmake file, as I can't figure out how to factor this out into a variable and maintain the proper quoting of the space separated strings. Signed-off-by: David Brown <[email protected]>
The rust docs don't have a convenient index file, so add this one, which will be included in the docs. Signed-off-by: David Brown <[email protected]>
This attempts to build the project documentation, for PRs uploading it to a working directory for the PR. Signed-off-by: David Brown <[email protected]>
Don't rely on "latest" but run on a specific version. Pick the 24.04, which has recently become available. Signed-off-by: David Brown <[email protected]>
teburd
approved these changes
Dec 17, 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 attempts to build the project documentation, for PRs uploading it to a working directory for the PR.
This PR will likely need lots of revisions, as it is primarily tested by uploading the PR.
I haven't figured out how to get a workflow that has permissions to add a comment or status giving a link to the docs, so we can do that later. For now, the docs for this change can be visited manually.