{"categories":[{"label":"Sphinx","url":"https://skillfed.io/packages/category/documentation-sphinx"}],"enrichment":{"capability":"A Sphinx extension that selectively removes toctree objects from specified pages to reduce documentation build time, particularly for projects with large auto-generated API documentation.","skillfed_tags":["sphinx-extension","build-optimization","documentation"],"use_cases":["Speed up Sphinx builds for projects with auto-generated API documentation using autosummary","Remove stub pages from sidebar navigation without triggering missing-file warnings","Optimize documentation rendering for themes with collapsible sidebar sections","Reduce build time for large nested documentation hierarchies","Selectively hide generated API pages from table of contents while keeping them accessible"],"what_it_does":"sphinx-remove-toctrees is a Sphinx extension that speeds up documentation builds by removing toctree objects from pages you specify. It works by intercepting Sphinx's build process after the initial validation phase but before HTML rendering, selectively deleting toctree entries that match glob-like patterns you configure in conf.py. This is most useful when your documentation uses autosummary to generate many stub pages\u2014each one adds overhead to the build, especially in themes that render the entire table of contents on every page.\n\nYou configure it by adding a list of glob patterns to a `remove_from_toctrees` key in conf.py, specifying which pages should be removed from the sidebar. The extension ensures no warnings are raised about missing files while still removing them from the rendered navigation, avoiding the link-resolution overhead that slows large builds.","worth_installing":"Yes, if you maintain Sphinx documentation with large auto-generated API sections and experience slow builds. The extension is straightforward to configure, has no complex dependencies, and solves a specific performance problem. The dormant maintenance status is acceptable for a focused, stable tool\u2014no active vulnerabilities and it supports current Python versions."},"id":"sphinx-remove-toctrees","links":{"html":"https://skillfed.io/packages/sphinx-remove-toctrees","md":"https://skillfed.io/packages/sphinx-remove-toctrees.md","pypi":"https://pypi.org/project/sphinx-remove-toctrees/"},"maintenance":{"status":"dormant"},"meta":{"latest_release":"2024-03-22","license_spdx":null,"license_treatment":"permissive","name":"sphinx-remove-toctrees","python_support":"supports_current","summary":"Reduce your documentation build size by selectively removing toctrees from pages."},"popularity":{"monthly_downloads":147888,"position":11050,"tier":"top_15000"},"security":{"n_vulnerabilities":0},"version":"1.0.0.post1"}