[Python-Dev] rst files

Carol Willing willingc at willingconsulting.com
Sat Jan 24 01:13:03 CET 2015


Hello Ethan,

In addition to Guido's suggestion, the Python Developer Guide's Section 
7.4.9 should be helpful. Here's a link to Section 7 on Restructured Text 
https://docs.python.org/devguide/documenting.html#restructuredtext-primer
You may also find the Sphinx project documentation helpful if you need 
additional details.

Carol

On 23/01/2015 15:55, Guido van Rossum 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 
> <mailto: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?
>
>     --
>     ~Ethan~
>
>
>     _______________________________________________
>     Python-Dev mailing list
>     Python-Dev at python.org <mailto:Python-Dev at python.org>
>     https://mail.python.org/mailman/listinfo/python-dev
>     Unsubscribe:
>     https://mail.python.org/mailman/options/python-dev/guido%40python.org
>
>
>
>
> -- 
> --Guido van Rossum (python.org/~guido <http://python.org/%7Eguido>)
>
>
> _______________________________________________
> Python-Dev mailing list
> Python-Dev at python.org
> https://mail.python.org/mailman/listinfo/python-dev
> Unsubscribe: https://mail.python.org/mailman/options/python-dev/willingc%40willingconsulting.com


-- 
*Carol Willing*
Developer | Willing Consulting
https://willingconsulting.com
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://mail.python.org/pipermail/python-dev/attachments/20150123/5af69519/attachment.html>


More information about the Python-Dev mailing list