Hi,

On Wed, 26 Jul 2023 08:20:19 -0700 (PDT), Lisa Scheuplein wrote:

> I have looked at directives and this one is not listed in the
> documentation. The previous writer used it for a table of contents at
> the top of the page.
> 
> From what I can figure out, it pulls from the heading style, H1, and it
> puts a little TOC at the top of the page.
> 
> Can someone confirm this is what I am seeing? Not sure why it is not in
> the documentation. I am a newbie to all this and figuring it out as I go
> along.
There is a mention of contents:: in a note, the second you find in [1], 
which explains its purpose:

"""To create table of contents for current document (.rst file), use the 
standard reST contents directive."""

HTH,
Stefano
[1] https://www.sphinx-doc.org/en/master/usage/restructuredtext/
directives.html#table-of-contents

> 
> .. contents::
>    :local: :backlinks: none :depth: 1
> 
> Thank you.
> 
> Lisa


-- 
You received this message because you are subscribed to the Google Groups 
"sphinx-users" group.
To unsubscribe from this group and stop receiving emails from it, send an email 
to sphinx-users+unsubscr...@googlegroups.com.
To view this discussion on the web visit 
https://groups.google.com/d/msgid/sphinx-users/u9t3dl%24b5m%241%40ciao.gmane.io.

Reply via email to