Fix API doc generation for Jetty #609
Merged
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
Signed-off-by: Addisu Z. Taddese <addisu@openrobotics.org>
Signed-off-by: Addisu Z. Taddese <addisu@openrobotics.org>
Signed-off-by: Addisu Z. Taddese <addisu@openrobotics.org>
Contributor
Author
|
Running the API Doc generation job manually: https://github.com/gazebosim/docs/actions/runs/17285450094. This will do all the steps except deploy the generated docs. |
Contributor
Author
|
Inspecting the generated archive (https://github.com/gazebosim/docs/actions/runs/17285450094/artifacts/3869862854), I think it's working properly: ├── cmake
│ ├── 2
│ │ └── index.html
│ ├── 3
│ │ └── index.html
│ ├── 4
│ │ └── index.html
│ └── 5
│ └── index.html
├── common
│ ├── 4
│ │ └── index.html
│ ├── 5
│ │ └── index.html
│ ├── 6
│ │ └── index.html
│ └── 7
│ └── index.html
├── fuel_tools
│ ├── 10
│ │ └── index.html
│ ├── 11
│ │ └── index.html
│ ├── 7
│ │ └── index.html
│ └── 9
│ └── index.html
├── gazebo
│ └── 6
│ └── index.html
├── gui
│ ├── 10
│ │ └── index.html
│ ├── 6
│ │ └── index.html
│ ├── 8
│ │ └── index.html
│ └── 9
│ └── index.html
├── launch
│ ├── 5
│ │ └── index.html
│ ├── 7
│ │ └── index.html
│ ├── 8
│ │ └── index.html
│ └── 9
│ └── index.html
├── math
│ ├── 6
│ │ └── index.html
│ ├── 7
│ │ └── index.html
│ ├── 8
│ │ └── index.html
│ └── 9
│ └── index.html
├── msgs
│ ├── 10
│ │ └── index.html
│ ├── 11
│ │ └── index.html
│ ├── 12
│ │ └── index.html
│ └── 8
│ └── index.html
├── physics
│ ├── 5
│ │ └── index.html
│ ├── 7
│ │ └── index.html
│ ├── 8
│ │ └── index.html
│ └── 9
│ └── index.html
├── plugin
│ ├── 1
│ │ └── index.html
│ ├── 2
│ │ └── index.html
│ ├── 3
│ │ └── index.html
│ └── 4
│ └── index.html
├── rendering
│ ├── 10
│ │ └── index.html
│ ├── 6
│ │ └── index.html
│ ├── 8
│ │ └── index.html
│ └── 9
│ └── index.html
├── sdformat
│ ├── 12
│ │ └── index.html
│ ├── 14
│ │ └── index.html
│ ├── 15
│ │ └── index.html
│ └── 16
│ └── index.html
├── sensors
│ ├── 10
│ │ └── index.html
│ ├── 6
│ │ └── index.html
│ ├── 8
│ │ └── index.html
│ └── 9
│ └── index.html
├── sim
│ ├── 10
│ │ └── index.html
│ ├── 6
│ │ └── index.html
│ ├── 8
│ │ └── index.html
│ └── 9
│ └── index.html
├── tools
│ ├── 1
│ │ └── index.html
│ └── 2
│ └── index.html
├── transport
│ ├── 11
│ │ └── index.html
│ ├── 13
│ │ └── index.html
│ ├── 14
│ │ └── index.html
│ └── 15
│ └── index.html
└── utils
├── 1
│ └── index.html
├── 2
│ └── index.html
├── 3
│ └── index.html
└── 4
└── index.html
|
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.
🦟 Bug fix
Fixes #607
Summary
This relies on the
index.yamlfile at the root of this repo to determine the version number if it can be obtained from the build directory names. It setsmerge-multiple: falsein the download action so that the downloaded artifact will have the directory structure as shown in the comments at the top of the file:docs/tools/restructure_doxygen_artifacts.py
Lines 7 to 27 in a63b7b7
I've also added proper argument parsing and functionality to test this locally by generating test files using the
--gen-test-filesflag.Checklist
codecheckpassed (See contributing)Generated-by: Remove this if GenAI was not used.
Note to maintainers: Remember to use Squash-Merge and edit the commit message to match the pull request summary while retaining
Signed-off-byandGenerated-bymessages.