Authors of existing auto-documentation tools areĮncouraged to integrate the reStructuredText parser into their Source “Reader” which will implement auto-documentation fromĭocstrings. Standalone reStructuredText documents and PEPs can beĬonverted to HTML other output format writers are being worked on and The reStructuredText parser is available now, part of the Docutils To and from footnotes automatic tables of contents (with live Makes it all accessible to readers: inline live hyperlinks live links The markup offers functionality and expressivity, while maintainingĮasy readability in the source text. Of course, to write reStructuredText documents some prior To produce complex documents, and extensible so that there are few *emphasis*), so it reads quite naturally. ReStructuredText is entirely readable in plaintextįormat, and many of the markup forms match common usage (e.g., Intended to be easily readable in source form, without prior knowledge Systems readers are only meant to see the processed form, either on Most markups are designed for the authors and software Who write the documents, the software systems that process the data,Īnd the readers, who are the final consumers and the most important Into useful, high-quality documentation for multiple purposes.ĭocument markup languages have three groups of customers: the authors Of the Python Documentation Special Interest Group ( Doc-SIG) has beenĪ markup syntax and toolset to allow auto-documentation, where theĭocstrings of Python systems can be extracted in context and processed Python allows us to document our code from within. We reuse code with functions,Ĭlasses, modules, and subsystems. The reStructuredText markup is an alternative for those To deprecate pure plaintext docstrings, which are always going to be PEP 256 for a “Road Map to the Docstring PEPs”). Is not concerned with docstring semantics or processing at all (see Only the low-level syntax of docstrings is addressed here. What-you-see-is-what-you-get plaintext markup syntax. ReStructuredText is a rich and extensible yet easy-to-read, Markup format for structured plaintext documentation in Pythonĭocstrings, and for PEPs and ancillary documents as well. Proposes that the reStructuredText markup be adopted as a standard Python programmers have sought out a format for docstrings. When plaintext hasn’t been expressive enough for inline documentation, Toggle light / dark / auto colour theme PEP 287 – reStructuredText Docstring Format Author : David Goodger Discussions-To : Doc-SIG list Status : Active Type : Informational Created : 2 Post-History : 0 Replaces : 216 PEP 287 – reStructuredText Docstring Format | Following system colour scheme Selected dark colour scheme Selected light colour scheme Python Enhancement Proposals
0 Comments
Leave a Reply. |
AuthorWrite something about yourself. No need to be fancy, just an overview. ArchivesCategories |