https://github.com/sphinx-contrib/fulltoc
Extension for Sphinx to make the sidebar show a full table of contents instead of just the local headings
https://github.com/sphinx-contrib/fulltoc
Last synced: 7 days ago
JSON representation
Extension for Sphinx to make the sidebar show a full table of contents instead of just the local headings
- Host: GitHub
- URL: https://github.com/sphinx-contrib/fulltoc
- Owner: sphinx-contrib
- License: apache-2.0
- Created: 2012-08-04T14:28:39.000Z (almost 13 years ago)
- Default Branch: master
- Last Pushed: 2023-08-22T17:08:21.000Z (over 1 year ago)
- Last Synced: 2025-04-24T10:52:44.864Z (16 days ago)
- Language: Python
- Size: 34.2 KB
- Stars: 39
- Watchers: 13
- Forks: 20
- Open Issues: 9
-
Metadata Files:
- Readme: README.rst
- License: LICENSE
Awesome Lists containing this project
README
.. -*- 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