Deploy rosdep documentation via GitHub Pages. - #980
Open
nuclearsandwich wants to merge 4 commits into
Open
Conversation
I had to comment out the example intersphinx mapping as None is apparently no longer a valid map value. I also attempted to use extras_require to specify documentation dependencies which are probably incomplete but it was enough to build on my machine.
I prefer the now acceptable build.earth filename over for the Filefile-style Earthfile. Along with the build.earth I've also included a .earthlyignore file which uses the same format as a [.dockerignore] file. Although we are not creating distributable images ignoring spurious files in the docker context helps cut down on cache misses invalidating dependency layers in the build. [.dockerignore]: https://docs.docker.com/build/concepts/context/#dockerignore-files
nuclearsandwich
force-pushed
the
docdeps
branch
from
August 20, 2024 03:55
9640b76 to
5265d18
Compare
nuclearsandwich
force-pushed
the
docdeps
branch
from
August 20, 2024 04:01
5265d18 to
996815f
Compare
I thought that workflows were isolated but jobs were not. Ah well.
nuclearsandwich
had a problem deploying
to
github-pages
August 20, 2024 04:06 — with 
GitHub Actions
Failure
GitHub Actions
Failure
nuclearsandwich
had a problem deploying
to
github-pages
August 20, 2024 04:20 — with
GitHub Actions
Failure
GitHub Actions
Failure
nuclearsandwich
changed the title
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
I'm considering updates to the ROS infrastructure package documentation to be maintained as part of the OSRA Infrastructure website.
I added an earthly build for docs in order to avoid adding an Actions-specific doc job.
That build supports the direct GitHub Pages upload.
To support the doc task I added an additional
docsection to extras_require which I think is a pattern worth applying to the other ROS infrastructure packages as well.In order to get docs building locally, I had to comment out the example intersphinx mapping as None is apparently no longer a valid map value.