Author: | David Goodger |
---|---|
Contact: | docutils-develop@lists.sourceforge.net |
Date: | 2022-06-13 |
Revision: | 9069 |
Copyright: | This document has been placed in the public domain. |
The latest working documents may be accessed individually below, or from the docs directory of the Docutils distribution.
Contents
Docutils stakeholders can be categorized in several groups:
There's a lot of overlap between these groups. Most (perhaps all) core-developers, component-developers, client-developers, and re-implementers 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.
These files are for all Docutils stakeholders. They are kept at the top level of the Docutils project directory.
README: | Project overview: quick-start, requirements, installation, and usage. |
---|---|
COPYING: | Conditions for Docutils redistribution, with links to licenses. |
FAQ: | Docutils Frequently Asked Questions. If you have a question or issue, there's a good chance it's already answered here. |
BUGS: | A list of known bugs, and how to report a bug. |
RELEASE-NOTES: | Summary of the major changes in recent releases and notice of future incompatible changes. |
HISTORY: | Detailed change history log. |
THANKS: | Acknowledgements. |
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.
Please note that PEPs in the master repository developed independent from the local versions after submission.
The Docutils Design Specification (PEP 258) is a must-read for any Docutils developer.