Open main menu
Home
Random
Recent changes
Special pages
Community portal
Preferences
About Wikipedia
Disclaimers
Incubator escapee wiki
Search
User menu
Talk
Dark mode
Contributions
Create account
Log in
Editing
ReStructuredText
(section)
Warning:
You are not logged in. Your IP address will be publicly visible if you make any edits. If you
log in
or
create an account
, your edits will be attributed to your username, along with other benefits.
Anti-spam check. Do
not
fill this in!
{{short description|Lightweight markup language}} {{distinguish|Representational state transfer}} {{Infobox file format | name = reStructuredText | logo = | icon = [[File:ReStructuredText Logo.svg|frameless|reStructuredText logo]] | iconcaption = | screenshot = | caption = | extension = .rst | mime = {{plainlist| * text/x-rst * text/prs.fallenstein.rst}} | type code = | uniform type = | conforms to = | magic = | owner = David Goodger | released = {{Start date and age|2001|06|01}}<ref name="rst-first-release" /> | latest release version = Revision 8407 | latest release date = {{Start date and age|2019|10|29}} | genre = | container for = | contained by = | extended from = | extended to = | standard = | open = [[Public domain]] | url = {{URL|https://docutils.sourceforge.io/rst.html}} }} '''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 Special Interest Group), aimed at creating a set of tools for Python similar to [[Javadoc]] for [[Java (programming language)|Java]] or [[Plain Old Documentation]] (POD) for [[Perl]]. Docutils can extract comments and information from Python programs, and format them into various forms of program documentation.<ref>{{cite web | last = Mertz | first = David | title = XML Matters: reStructuredText | publisher = IBM developerWorks | date = 2003-02-01 | url = https://www.ibm.com/developerworks/library/x-matters24/ | access-date = 2016-10-05 }}</ref> In this sense, reStructuredText is a [[lightweight markup language]] designed to be both processable by documentation-processing software such as Docutils, and be easily readable by human programmers who are reading and writing Python [[source code]].
Edit summary
(Briefly describe your changes)
By publishing changes, you agree to the
Terms of Use
, and you irrevocably agree to release your contribution under the
CC BY-SA 4.0 License
and the
GFDL
. You agree that a hyperlink or URL is sufficient attribution under the Creative Commons license.
Cancel
Editing help
(opens in new window)