sphinxcontrib-fulltoc

Include a full table of contents in your Sphinx HTML sidebar

3 个版本
Doug Hellmann <doug@doughellmann.com>
安装
pip install sphinxcontrib-fulltoc
poetry add sphinxcontrib-fulltoc
pipenv install sphinxcontrib-fulltoc
conda install sphinxcontrib-fulltoc
描述

.. -- mode: rst --

======================= sphinxcontrib-fulltoc

sphinxcontrib-fulltoc is an extension for the Sphinx_ documentation system that changes the HTML output to include a more detailed table of contents in the sidebar. By default Sphinx only shows the local headers for the current page. With the extension installed, all of the page titles are included, and the local headers for the current page are also included in the appropriate place within the document.

See the project documentation_ for more details.

.. _Sphinx: http://sphinx.pocoo.org

.. _project documentation: http://sphinxcontrib-fulltoc.readthedocs.org