David Goodger
The latest working documents may be accessed individually below, or from the docs directory of the Docutils distribution.
users of reStructuredText and the Docutils tools. Although some are developers (e.g. Python developers utilizing reStructuredText for docstrings in their source), many are not.
Client-developersdevelopers using Docutils as a library, programmers developing with Docutils.
Component-developersthose who implement application-specific components, directives, and/or roles, separately from Docutils.
Core-developerscontributors to the Docutils codebase and participants in the Docutils project community.
Re-implementersdevelopers of alternate implementations of Docutils.
Most (perhaps all) developers are also end-users. Core-developers are also client-developers, and may also be component-developers in other projects. Component-developers are also client-developers.
Project FundamentalsThese files are for all Docutils stakeholders. They are kept at the top level of the Docutils project directory.
Project overview: quick-start, requirements, installation, and usage.
Conditions for Docutils redistribution, with links to licenses.
Docutils Frequently Asked Questions. If you have a question or issue, there's a good chance it's already answered here.
A list of known bugs, and how to report a bug.
Summary of the major changes in recent releases and notice of future incompatible changes.
Detailed change history log.
Acknowledgements.
A ReStructuredText Primer (see also the text source)
Quick reStructuredText (user reference)
reStructuredText Cheat Sheet (text only; 1 page for syntax, 1 page directive & role reference)
Demonstration of most reStructuredText features (see also the text source)
Many of these files began as developer specifications, but now that they're mature and used by end-users and client-developers, they have become reference material. Successful specs evolve into refs.
The Docutils Document Tree (incomplete)
OASIS XML Exchange Table Model Declaration Module (CALS tables DTD module)
Docutils Design Specification (PEP 258)
An Introduction to reStructuredText (includes the Goals of reStructuredText)
LaTeX syntax for mathematics (syntax used in "math" directive and role)
PEP 256: Docstring Processing System Framework is a high-level generic proposal. [PEP 256 in the master repository]
PEP 257: Docstring Conventions addresses docstring style and touches on content. [PEP 257 in the master repository]
PEP 258: Docutils Design Specification is an overview of the architecture of Docutils. It documents design issues and implementation details. [PEP 258 in the master repository]
PEP 287: reStructuredText Docstring Format proposes a standard markup syntax. [PEP 287 in the master repository]
Please note that PEPs in the master repository developed independent from the local versions after submission.
entry points for using Docutils as a library
configuration framework details
change the document tree in-place (resolve references, â¦)
The Docutils Design Specification (PEP 258) is a must-read for any Docutils developer.
Docutils Enhancement Proposals Instructions for DevelopersRetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4