Remove unneeded .doctrees from sphinx output #150
Merged
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
tfoote
approved these changes
Oct 29, 2024
There was a problem hiding this comment.
Confirmed as unnecessary https://www.sphinx-doc.org/en/master/man/sphinx-build.html#cmdoption-sphinx-build-d
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.
When running rosdoc2 over entire distros (using the scan option), disk usage is quite large. Investigating, the majority of that disk usage is in the .doctrees folder. AFAICT, this folder is only used during generation of the toctrees, and is not needed for display of the documentation from the html.
This is also an issue on the standard buildfarm, though not as bad. See https://docs.ros.org/en/rolling/p/rclcpp/.doctrees/ for example.
This PR deletes the .doctrees folder after the sphinx documentation generation is complete.