Refer to Field Lists for moreĪ role or “custom interpreted text role” ( ref) is an inline Sphinx extends standard docutils behavior and intercepts field lists specifiedĪt the beginning of documents. :returns: A message (just for me, of course). :param my_other_arg: The second of my arguments. :param my_arg: The first of my arguments. With a blank line and should not end with an unused prompt: Doctest blocks ¶ĭoctest blocks ( ref) are interactive Python sessionsĬut-and-pasted into docstrings. TheĬode-block directive can be used to set highlighting on aīlock-by-block basis. Using the highlight_language configuration option. Rendered as “The next paragraph is a code sample:”.Ĭode highlighting can be enabled for these literal blocks on a document-wideīasis using the highlight directive and on a project-wide basis That way, the second sentence in the above example’s first paragraph would be If it is preceded by non-whitespace, the marker is replaced by a single If it is preceded by whitespace, the marker is removed. If it occurs as a paragraph of its own, that paragraph is completely left out The next paragraph is a code sample :: It is not processed in any way, except that the indentation is removed. Lists they can also be autonumbered using a # sign: The start of a paragraph and indent properly. List markup ( ref) is natural: just place an asterisk at It is also possible to replace or expand upon some of this inline markup with These restrictions may be lifted in future versions of the docutils. Use aīackslash escaped space to work around that: thisis\ *one*\ word. It must be separated from surrounding text by non-word characters. Inline markup delimiters, they have to be escaped with a backslash.īe aware of some restrictions of this markup:Ĭontent may not start or end with whitespace: * text* is wrong, If asterisks or backquotes appear in running text and could be confused with
Two asterisks: **text** for strong emphasis (boldface), and One asterisk: *text* for emphasis (italics), The standard reST inline markup is quite simple: use Same paragraph must be left-aligned to the same level of indentation. As in Python, indentation is significant in reST, so all lines of the Paragraphs are simply chunks of text separated by one or more blank The paragraph ( ref) is the most basic block in a reSTĭocument. The “ref” links in thisĭocument link to the description of the individual constructs in the reST The authoritative reStructuredText User Documentation.
0 kommentar(er)
