[Date Prev][Date Next] [Thread Prev][Thread Next] [Date Index] [Thread Index]

Bug#1001607: ITP: sphinx-remote-toctree -- Reduce sphinx documentation build times



Package: wnpp
Severity: wishlist
Owner: Diane Trout <diane@ghic.org>
X-Debbugs-Cc: debian-devel@lists.debian.org

* Package name    : sphinx-remote-toctree
  Version         : 0.0.3
  Upstream Author : Chris Holdgraf
* URL             : https://github.com/executablebooks/sphinx-remove-toctrees
* License         : Expat
  Programming Lang: (Python
  Description     : Reduce sphinx documentation build times

( 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.


dask decided to require this package as a dependendcy for building
documentation.


Reply to: