python3-sphinx-remove-toctrees

Reduce sphinx documentation build times

Description

Improve your Sphinx build time by selectively removing TocTree objects from pages. This is useful if your documentation uses auto-generated API documentation, which generates **a lot** of stub pages.

This extension can be used to remove the sidebar links for just the pages you specify, speed up the build considerably.

## Who is this for?

This package is for maintainers that use Sphinx and have really large API documentation (or for some other reason, have a ton of nested pages). If you use a Sphinx theme that contains the entire Table of Contents on every page (e.g., any theme that has "collapsable" sidebar sections), this will slow things down considerably. Use this theme to speed up your builds.

Upload more screenshots

Please help extend the collection of screenshots. Just make a screenshot and upload it here. You don't need to register or anything.

Upload a screenshot

Hint: upload an image here from your clipboard with Ctrl-V


Homepage

https://github.com/executablebooks/sphinx-remove-toctrees


Install this software package

If the package is available for the distribution you are currently using on your computer then install the software by clicking on…

Install python3-sphinx-remove-toctrees