reStructuredText (reST)


reStructuredText (reST) is a document encoding format used primarily in the context of interspersing documentation with source code, especially in the Python ecosystem. As such, it offers greater control than markdown when it comes to programming-language specific details such as the documentation of input arguments and return values.

reST embraces the tenets of automated content generation and decoupled rendering by facilitating the production of documentation in various formats directly from source code.

reST can also be used to produce standalone documents. Notwithstanding its Python origins, it is not an obscure format. It is supported by GitHub and Bitbucket, among others. Also, similarly to asciidoc, it has syntactic support for paper-oriented use cases such as the inclusion of bibliographical references. The complete specification is here.

Example


© 2022-2024 Ernesto Garbarino | Contact me at ernesto@garba.org