reStructuredText
E255494
reStructuredText is a lightweight, plaintext markup language commonly used in the Python ecosystem for documentation, including PEPs and Sphinx-based docs.
All labels observed (1)
| Label | Occurrences |
|---|---|
| reStructuredText canonical | 4 |
Statements (73)
| Predicate | Object |
|---|---|
| instanceOf |
documentation format
ⓘ
lightweight markup language ⓘ plaintext markup language ⓘ |
| abbreviation | reST ⓘ |
| category |
documentation systems
ⓘ
lightweight markup languages ⓘ |
| commonlyUsedWith |
Docutils
ⓘ
Python Package Index ⓘ
surface form:
PyPI
Python Enhancement Proposals ⓘ Read the Docs ⓘ Sphinx ⓘ |
| designedBy | David Goodger ⓘ |
| designedFor |
easy readability in plain text
ⓘ
unambiguous structure in plain text ⓘ |
| ecosystem | Python ecosystem ⓘ |
| fileExtension |
.rest
ⓘ
.rst ⓘ |
| fullName | reStructuredText ⓘ |
| hasImplementation | Docutils ⓘ |
| influenced |
Python documentation practices
ⓘ
Sphinx markup conventions ⓘ |
| license | BSD-like license (via Docutils) ⓘ |
| originProject | Docutils project ⓘ |
| outputFormats |
EPUB
ⓘ
surface form:
EPUB via Sphinx
HTML ⓘ LaTeX ⓘ ODF via converters ⓘ PDF via LaTeX or other toolchains ⓘ XML ⓘ man pages ⓘ |
| parsedBy |
Docutils
ⓘ
Pandoc ⓘ Sphinx ⓘ |
| primaryUse |
Python documentation
ⓘ
software documentation ⓘ technical documentation ⓘ |
| standardizedIn | Docutils documentation ⓘ |
| supportsExtensionMechanism |
directives
ⓘ
roles ⓘ |
| supportsFeature |
admonitions
ⓘ
bullet lists ⓘ citations ⓘ code blocks ⓘ definition lists ⓘ directives ⓘ embedded images ⓘ enumerated lists ⓘ field lists ⓘ footnotes ⓘ hyperlinks ⓘ inline markup ⓘ inline roles ⓘ lists ⓘ literal blocks ⓘ math markup via extensions ⓘ paragraphs ⓘ section headings ⓘ substitutions ⓘ tables ⓘ |
| supportsInlineMarkup |
emphasis
ⓘ
hyperlink references ⓘ inline literals ⓘ interpreted text ⓘ strong emphasis ⓘ substitution references ⓘ |
| syntaxStyle |
ASCII-based
ⓘ
plain text ⓘ |
| typicalSectionUnderlineChars | = - ` : ' " ~ ^ _ * + # < > ⓘ |
| usedFor |
API reference documentation
ⓘ
Python Enhancement Proposals ⓘ README files ⓘ Sphinx documentation ⓘ project documentation on PyPI ⓘ |
Referenced by (4)
Full triples — surface form annotated when it differs from this entity's canonical label.