the usual use of toctree
in sphinx looks this:
.. toctree:: :maxdepth: 2 foo bar baz
and if, example, foo.rst
starts title heading "being foo", bar.rst
starts "doing bar", , baz.rst
starts "thinking baz" nice table of contents looks this:
with links each appropriate page.
my question: is there way annotate toctree? example, if wanted annotate "being foo" heading "w. robert foo created first metasyntactic variable in 1857 , we've been using ever since.", put text somewhere (hopefully @ top of foo.rst
, if not, in toctree directive) , toctree output this:
- being foo — w. robert foo created first metasyntactic variable in 1857 , we've been using ever since.
- doing bar
- thinking baz
you can override page title using following syntax:
.. toctree:: :maxdepth: 2 being foo - w. robert foo created first metasyntactic variable in 1857 <foo> bar baz
http://www.sphinx-doc.org/en/stable/markup/toctree.html?highlight=entries
however you'd lose auto-title, may main part of question?
Comments
Post a Comment