Create a parser:: parser = () Several optional arguments may be passed to modify the parser’s behavior. Please see. reStructuredText (RST, ReST, or reST) is a file format for textual data used primarily in the Python programming language community for technical documentation. It is part of the Docutils project of the Python Doc-SIG ( Documentation. RST is a file format formely created by Python community to write documentation (and so, is part of Docutils). RST files are simple text files with lightweight syntax.
|Published (Last):||14 November 2012|
|PDF File Size:||2.96 Mb|
|ePub File Size:||3.72 Mb|
|Price:||Free* [*Free Regsitration Required]|
Below are examples of section title styles: See Implicit Hyperlink Targets for a complete description. It may be desirable to use inline literals for some of these anyhow, especially if they represent code snippets.
For example, here is a truth table, a three-column table with one header row and four body rows: For languages that don’t use whitespace between words dpcutils. This example illustrates continuation lines: Tab stops are at every 8th column. Simple tables provide a compact and easy to type but limited row-oriented table representation for simple data sets.
When resolving reference names internally:. You need to call this before using a RstGenerator with any other procs in this module.
reStructuredText Markup Specification
Substitution definitions are indicated by an explicit markup start “. If you need a generic block-level container, please use the container directive, described below.
As reStructuredText doesn’t support nested inline markup, the only way to create a reference with styled text is to use substitutions with the “replace” directive:. The use of “raw” ties documents to specific output formats and makes them less portable.
If the image file is not found or the required software is unavailable, this option is ignored. Quoted literal blocks are unindented contiguous blocks of text where each line begins with the same non-alphanumeric printable 7-bit ASCII character .
Used to reserve space or scale the image vertically. The Emacs table mode is a tool that allows easy editing of grid tables, in Emacs. The number of required arguments default: Literal blocks in which no markup processing is done are used for examples throughout this document, to illustrate the plaintext markup. This construct offers easy authoring and maintenance of hyperlinks at the expense of general dicutils.
Paragraphs consist of dofutils of left-aligned text with no markup indicating any other body element. For example, bullet list bodies must be indented by at least two columns relative to the left edge of the bullet:.
Since all indentation is significant, the level of indentation must be consistent. Admonitions Specific Admonitions Directive Types: Tables’ left edges should align with the left edge of doxutils text blocks; if indented, the table is considered to be part of a block quote.
See the class directive above. Some META tags use an “http-equiv” attribute instead of the “name” attribute. Transition markers require blank lines before and after: Generated by Docutils from reStructuredText source. Grid tables ; complete, but complex and verbose: Field lists are used as part of an extension syntax, such as options for directivesor database-like records meant for further processing.
Interpreted as the figure caption and an optional legend. Citation References See also: I read through all the reStructuredText docs, dovutils the text versions to the html versions. This will add a paragraph to the document header, which will appear at the top of the generated web page or at the top of every printed docutills.
Directive arguments can be filesystem paths, URLs, title text, etc. Arguments are normally single whitespace-separated words.