admin 24 February, 2019 0


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: Nilkree Dudal
Country: Estonia
Language: English (Spanish)
Genre: Literature
Published (Last): 19 January 2010
Pages: 419
PDF File Size: 12.32 Mb
ePub File Size: 18.59 Mb
ISBN: 466-8-42665-733-9
Downloads: 14021
Price: Free* [*Free Regsitration Required]
Uploader: Brajas

The spaces between the arguments are ignored and thus do not appear in the output. Reference names are whitespace-neutral and case-insensitive.

Source Edit proc mergeIndexes dir: The input format is LaTeX math syntax [1] with support for Unicode symbols, for example: A short example is unavoidably contrived: As a convenience, the “:: Generic Admonition Directive Type: Literal blocks are either indented or line-prefix-quoted blocks, and indicated with a double-colon “:: The “epigraph” directive produces an “epigraph”-class block quote.

Note the adjustment for the required two spaces. The role may be inferred implicitly as above; the “default dcoutils is used or indicated explicitly, using a role marker.

Block Quotes Doctree element: Emphasized text is typically displayed in italics. Some care should be taken to avoid reference name conflicts.


The “contents” directive generates a table of contents TOC in a topic. In most use cases, inline literals or literal blocks are docufils best choice by default, this also selects a monospaced font. The literal block must either be indented or quoted see below. The filename parameter will be used for error reporting and creating index hyperlinks to the file, but you can pass an empty string here if you are parsing a stream in memory.

The following enumeration sequences are recognized: Hyperlinks consist of two parts. Autonumber labels do two things:. If you need to allow the rst include directive or tweak the generated output you have to create your own RstGenerator with initRstGenerator and related procs. With code or literal the common options: Interpreted text allows extensions to the available inline descriptive markup constructs.

See the class directive below. The syntax for a transition marker is a horizontal line of 4 or more repeated punctuation characters. Paragraphs and inline markup: For example, the following table contains a cell in row 2 spanning from column 2 to column Some META tags use an “http-equiv” attribute instead of the “name” attribute.

This field-name-to-element mapping can be replaced for other languages.

For example, indentation is the sole markup indicator for block quotes:. In reStructuredText we use the backslash, commonly used as an escaping character in other domains.


reStructuredText Directives

In addition, the following options are recognized: Being excerpts, there’s often context missing, which sometimes tones down the message. Since we are interested in different instances of the same term to have different rs, a table is used to keep track of the amount of times a term has previously appeared to give a different identifier value for each.

Interpreted text is enclosed by single backquote characters: Citation References See also: Actions taken in response to directives and the interpretation of text in the directive content block or subsequent text block s are directive-dependent. Literal block Fully minimized form: Max M on comp. Vertical bars are used to bracket the substitution reference text.

For example, a height of px and a scale of 50 is equivalent to a height of px with no scale. Returns the URI argument with whitespace removed.


All in all a good bargain. Inline markup start-strings must be immediately followed by non-whitespace. If no directive options are specified, a “class” option with the directive argument role name as the value is implied.