Skip to content

statease/sphinx-jsontoc-builder

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

3 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

json-toc-builder

Builder for sphinx that adds a "toctree" key to the json output with the full toctree.

Usage

Set the builder as a extension in conf.py:

extensions = ['sphinxcontrib.jsontoc']

Run sphinx-build with target jsontoc:

sphinx-build -b jsontoc -c . build/jsontoc

There is now a toctree key in every fjson file with the top level toctree (as opposed to the toc key which only has the current level).

About

JSON builder for Sphinx that has a 'toctree' key with a top-level toctree (similar to rtd toc)

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages