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.

Author: Tauzilkree Grozil
Country: Ethiopia
Language: English (Spanish)
Genre: Spiritual
Published (Last): 26 December 2014
Pages: 283
PDF File Size: 17.23 Mb
ePub File Size: 16.34 Mb
ISBN: 998-3-71805-553-9
Downloads: 74668
Price: Free* [*Free Regsitration Required]
Uploader: Nishura

If an implementation of reStructuredText does not recognize a directive i. ReStructuredText provides two syntaxes for delineating table cells: Highlights summarize the main points of a document or section, often consisting of a list.

For example, here is a table with a column span in the header: They are a way to include arbitrarily complex inline structures within text, while keeping the details out of the flow of text. Warning The “csv-table” directive’s “: API indices will be all joined together into a single big sorted index, making the bulk of the final index. These consist of a scheme, a colon “: An option spec is a mapping of option name to conversion function; conversion functions are applied to each option value to check validity and convert them to the expected type.

In that case, that line of text is parsed as a continuation line. To set a “classes” attribute value on a block quote, the “class” directive must be followed by an empty comment:. There is no directive content. Substitution Definitions Doctree element: Phrase-references are expressed by enclosing the phrase in backquotes and treating the backquoted text docugils a reference name: See also the class directive.


reStructuredText Markup Specification

This module has been placed in the public domain. Only unused footnote numbers are assigned to auto-numbered footnotes. Content blocks separated by a blank line are put in adjacent math blocks. Paragraphs may contain inline markup. The literal block must either be indented or quoted see below.

If a directive that does not employ a content block is followed by docuils text anyway, it is an error. Incremental Text Examples 3: The field name becomes the contents of the “name” attribute of the META tag, and the field body interpreted as a single string without inline markup becomes the contents of the “content” attribute.

Bullet Lists Doctree elements: For example, this admonition:. Docutils identifiers are converted to conform to the regular expression [a-z] -?

The “default-role” directive sets the default interpreted text role, the role that is used for interpreted text without an explicit role. The syntax for a transition marker is a horizontal line of 4 or more repeated punctuation characters. Actions taken in response to directives and the interpretation of text in the directive content block or subsequent text block s are directive-dependent. The inline markup recognition order is as follows: Similarly, a lone second-level section title immediately after the “document title” can become the document subtitle.

Text enclosed by double-asterisks is emphasized strongly: Directive functions return doxutils list of nodes which will be inserted into the document tree at the point where the directive was encountered. Gather input a multi-line stringby reading a file or the standard input:: List of document markup languages. In reStructuredText, inline markup applies to words or phrases within a text block. The filename parameter will be used doocutils error reporting docutilss creating index hyperlinks to the docutilw, but you can pass an empty string here if you are parsing a stream in memory.


Problems of ambiguity due to conflicting duplicate implicit and explicit reference names are avoided by following this procedure:. There is no need to duplicate a URI.

As reStructuredText doesn’t support nested inline markup, the only way to create a reference with styled docutiks is to use substitutions with the “replace” directive:. This is a top-level paragraph. Imports rstastrsthighlite.


If you need a generic block-level container, please use the container directive, described below. Interpreted text allows extensions to the available inline descriptive markup constructs. The English default title text is “Contents”. Implicit hyperlink targets are generated by section titles, footnotes, and citations, and may also be generated by extension constructs.

Anonymous hyperlinks which see do not use reference names to match references to targets, but otherwise behave rzt to named hyperlinks. One or more, optional class names. Empty comments may be docutols to explicitly terminate preceding constructs that would otherwise consume a block quote: It will be replaced by the processing system.