Add never_run_doxygen and never_run_sphinx_apidoc options #159
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
Signed-off-by: R. Kent James <[email protected]
tfoote
requested changes
Nov 19, 2024
Signed-off-by: R. Kent James <[email protected]>
tfoote
approved these changes
Nov 21, 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.
Some large packages generate API documentation themselves. These same packages often take large amounts of time in rosdoc2 runs, with output that is not useful since the documentation options are often not optimal compared to the externally generated documentation.
This PR allows rosdoc2.yaml options to disable attempts by rosdoc2 to generate API docs in those cases.
An example is pinocchio which has complete documentation, including API documentation, at https://gepettoweb.laas.fr/doc/stack-of-tasks/pinocchio/master/doxygen-html/