Limit navigation_depth to 4, fixes #56 #89
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
Apr 2, 2024
There was a problem hiding this comment.
This is great to bring the disk space usage way down and also makes the navigation a little less cluttered. I see the collapse_navigation is False though the navigation seems to collapse by default now. But everything is still completely navigable. local testing on rclcpp took it from 1.6GB to 444MB on my machine.
|
Also side note it cuts the build time down to close to a third of the time as well for rclcpp. From 31 to 12 minutes |
rkent
added a commit
to rkent/rosdoc2
that referenced
this pull request
Apr 3, 2024
tfoote
pushed a commit
that referenced
this pull request
Apr 10, 2024
* Clarify directory naming * Refactor to write directly into wrapped directory * Add basic c++ test with custom conf.py * Create wrapped_sphinx_directory with an absolute path * Limit navigation_depth to 4 (#89) * Include user documents * Copy all contents of /doc * Fixups to match with refactor-sphinx-directories * Fix flake errors, use dir/ instead of doc/dir titles * Add tests for documentation
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.
Fixes #56
The html_theme_option 'navigation_depth' has a large impact on the size of the generated output. This patch changes that from infinite (-1) to 4.
Size effects for rmf_utils iron:
depth = 2: 60M
depth = 3: 61M
depth = 4: 112M
depth = -1: 332M
With depth = 4, the C++ API section in the toc shows like:
C++ API
--Full C++ API
----Classes and Structs
------Class LazyExpression
That is, the toc shows the class name, but not any details of the class. You need to click on the name to reach the class page to get that.
I think that is the right amount of detail, plus it is reducing the total file space to 1/3 of the current value.