[Python-Dev] rst files

R. David Murray rdmurray at bitdance.com
Sat Jan 24 01:15:59 CET 2015


On Fri, 23 Jan 2015 15:55:29 -0800, Guido van Rossum <guido at python.org> wrote:
> This adds entries to the index of the document -- similar to the index at
> the end of a book. I think single vs. double refers to different types of
> entries. Check out this page: https://docs.python.org/3/genindex.html
> 
> On Fri, Jan 23, 2015 at 3:43 PM, Ethan Furman <ethan at stoneleaf.us> wrote:
> 
> > Can somebody please explain this?
> >
> > .. index::
> >    single: formatting, string (%)
> >    single: interpolation, string (%)
> >    single: string; formatting
> >    single: string; interpolation
> >    single: printf-style formatting
> >    single: sprintf-style formatting
> >    single: % formatting
> >    single: % interpolation
> >
> > Specifically, what does index mean?  What does single vs double vs triple
> > mean?  Is there a reference somewhere I can read?

It is explained in the Sphinx documentation:
http://sphinx-doc.org/contents.html

Specifically:

http://sphinx-doc.org/markup/misc.html#directive-index

--David


More information about the Python-Dev mailing list