Skip to main content

Sphinx extension to allow .toc file to builde the Table of Contents

Project description

sphinxcontrib-toc is a Sphinx extension to allow .toc file to build the Table of Contents.

This extension empower you to build complicated document with markup languages which can not define toctrees. Specifically, combination with recommonmark, you don’t need to write any reStructuredText in your document!

Usage

Append this extension in conf.py:

extensions = ['sphinxcontrib.toc']

And configure following settings:

toc_title
The default title of toctree if no titles in .toc file. By default, "{project} Documentation".
toc_numbered
Same as :numbered: option of toctree directive. If enabled, Sphinx assigns section numbers. By default, true.

.toc file

.toc file is a list of documents like toctree directive:

section1
section2
section3

You may define the title of toctree at top of the file:

# The title of document
section1
section2
section3

Tips

You can use “nested” .toc file like following:

/index.toc
/part1.rst
/part2.rst
/part3/index.toc
/part3/section1.toc
/part3/section2.toc

# In /index.toc
part1
part2
part3/index

# In /part3/index.toc
section1
section2

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for sphinxcontrib-toc, version 1.0.0
Filename, size File type Python version Upload date Hashes
Filename, size sphinxcontrib_toc-1.0.0-py2.py3-none-any.whl (3.6 kB) File type Wheel Python version py2.py3 Upload date Hashes View
Filename, size sphinxcontrib-toc-1.0.0.tar.gz (3.4 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page