search

ros-infrastructure / rosdoc2

Command-line tool for generating documentation for ROS 2 packages.
Apache License 2.0
29 stars 9 forks source link

Limit navigation_depth to 4, fixes #56 #89

Closed rkent closed 3 months ago

rkent commented 3 months ago

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.

tfoote commented 3 months ago

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 image