Re: [Python-Dev] rst files
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 et...@stoneleaf.us mailto:et...@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@python.org mailto:Python-Dev@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@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 ___ Python-Dev mailing list Python-Dev@python.org https://mail.python.org/mailman/listinfo/python-dev Unsubscribe: https://mail.python.org/mailman/options/python-dev/archive%40mail-archive.com
Re: [Python-Dev] rst files
Many thanks to all responders! -- ~Ethan~ signature.asc Description: OpenPGP digital signature ___ Python-Dev mailing list Python-Dev@python.org https://mail.python.org/mailman/listinfo/python-dev Unsubscribe: https://mail.python.org/mailman/options/python-dev/archive%40mail-archive.com
Re: [Python-Dev] rst files
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 et...@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@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) ___ Python-Dev mailing list Python-Dev@python.org https://mail.python.org/mailman/listinfo/python-dev Unsubscribe: https://mail.python.org/mailman/options/python-dev/archive%40mail-archive.com
Re: [Python-Dev] rst files
On 1/23/2015 7:15 PM, R. David Murray wrote: On Fri, 23 Jan 2015 15:55:29 -0800, Guido van Rossum gu...@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 et...@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 The devguide has a cpython doc oriented intro to .rst that includes https://docs.python.org/devguide/documenting.html#index-generating-markup -- Terry Jan Reedy ___ Python-Dev mailing list Python-Dev@python.org https://mail.python.org/mailman/listinfo/python-dev Unsubscribe: https://mail.python.org/mailman/options/python-dev/archive%40mail-archive.com
Re: [Python-Dev] rst files
On Fri, 23 Jan 2015 15:55:29 -0800, Guido van Rossum gu...@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 et...@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 ___ Python-Dev mailing list Python-Dev@python.org https://mail.python.org/mailman/listinfo/python-dev Unsubscribe: https://mail.python.org/mailman/options/python-dev/archive%40mail-archive.com
Re: [Python-Dev] rst files
On 01/23/2015 03:43 PM, Ethan Furman 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? In restructured text (rst), the .. syntax starts a directive. There are a number of built-in directives, and there is the ability to extend the syntax with domain specific directives. That must be the case here (since there doesn't appear to be a built-in directive named index), so we'll need more information about the source of your rst file before we can answer anything about that particular add on directive. Gary Herron -- Dr. Gary Herron Department of Computer Science DigiPen Institute of Technology (425) 895-4418 ___ Python-Dev mailing list Python-Dev@python.org https://mail.python.org/mailman/listinfo/python-dev Unsubscribe: https://mail.python.org/mailman/options/python-dev/archive%40mail-archive.com
