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!
== Applications == reStructuredText is commonly used for technical documentation, for example, in documentation of Python libraries.<ref>{{cite web | last=Goodger | first=David | title=PEP 287 -- reStructuredText Docstring Format | date=2002-04-02 | url=https://www.python.org/dev/peps/pep-0287/ | publisher=[[Python Software Foundation]] | access-date=2016-10-05}}</ref> However, it is suitable for a wide range of texts. Since 2008, reST has been a core component of Python's [[Sphinx (documentation generator)|Sphinx]] document generation system. [[Trac]] also supports reStructuredText,<ref>{{cite web | url=https://trac.edgewall.org/wiki/WikiRestructuredText | title=reStructuredText Support in Trac | date=2016-09-13 | publisher=[[Trac]] | access-date=2016-10-05}}</ref> as do [[GitHub]] and [[Bitbucket]]. In 2011, [[Distributed Proofreaders]], which prepared texts for [[Project Gutenberg]], was considering adoption of reST as a basic format from which other ebook formats could be generated.<ref>{{cite web | last = Newby | first = Greg | title = Minutes of 2010 December 11 meeting | publisher = Distributed Proofreaders | date = 2011-01-08 | url = http://www.pgdp.net/phpBB2/viewtopic.php?t=44456 |url-access=registration | access-date = 2011-01-08 }}</ref>{{update inline|date=May 2015}} In July 2016 the [[Linux kernel]] project decided to transition from [[DocBook]] based documentation to reStructuredText and the [[Sphinx (documentation generator)|Sphinx]] toolchain.<ref>{{cite web | title = Kernel documentation with Sphinx, part 1: how we got here | publisher = LWN.net | date = 2016-07-06 | url = http://lwn.net/Articles/692704/ | access-date = 2016-10-27 }}</ref><ref>{{cite web | title=Sphinx. Linux kernel | publisher = Wikipedia | date = 2024-04-02 | url = https://en.wikipedia.org/wiki/Sphinx_(documentation_generator)#Linux_kernel | access-date = 2024-04-02}}</ref>{{Circular reference|date=May 2024}} The software build tool [[CMake]] switched from a custom markup language to reStructuredText in version 3.0 for its documentation.<ref>{{cite web | title = CMake 3.0.0 Release Notes | publisher = Kitware, Inc. | date = 2014-06-10 | url = https://cmake.org/cmake/help/v3.0/release/3.0.0.html | access-date = 2016-10-05 }}</ref>
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)