blob: 3ea311fa629dd2ba1482c351ef5684910816922d [file] [log] [blame]
Georg Brandl8ec7f652007-08-15 14:28:01 +00001=====================
2About these documents
3=====================
4
5
Georg Brandle11d85c2010-04-22 22:15:33 +00006These documents are generated from `reStructuredText`_ sources by `Sphinx`_, a
7document processor specifically written for the Python documentation.
8
Georg Brandl0f5d6c02014-10-29 10:57:37 +01009.. _reStructuredText: http://docutils.sourceforge.net/rst.html
Zachary Waref583f412014-01-14 16:01:32 -060010.. _Sphinx: http://sphinx-doc.org/
Georg Brandl8ec7f652007-08-15 14:28:01 +000011
Georg Brandlc03cd4c2009-05-16 11:24:41 +000012.. In the online version of these documents, you can submit comments and suggest
13 changes directly on the documentation pages.
Georg Brandl8ec7f652007-08-15 14:28:01 +000014
Zachary Waref583f412014-01-14 16:01:32 -060015Development of the documentation and its toolchain is an entirely volunteer
16effort, just like Python itself. If you want to contribute, please take a
17look at the :ref:`reporting-bugs` page for information on how to do so. New
18volunteers are always welcome!
Georg Brandl8ec7f652007-08-15 14:28:01 +000019
20Many thanks go to:
21
22* Fred L. Drake, Jr., the creator of the original Python documentation toolset
23 and writer of much of the content;
Georg Brandl0f5d6c02014-10-29 10:57:37 +010024* the `Docutils <http://docutils.sourceforge.net/>`_ project for creating
David Goodger67ea0022008-04-21 14:43:33 +000025 reStructuredText and the Docutils suite;
Georg Brandl8ec7f652007-08-15 14:28:01 +000026* Fredrik Lundh for his `Alternative Python Reference
27 <http://effbot.org/zone/pyref.htm>`_ project from which Sphinx got many good
28 ideas.
29
Ezio Melotti7d857602012-09-14 01:58:33 +030030
31Contributors to the Python Documentation
32----------------------------------------
33
34Many people have contributed to the Python language, the Python standard
35library, and the Python documentation. See :source:`Misc/ACKS` in the Python
36source distribution for a partial list of contributors.
Georg Brandl8ec7f652007-08-15 14:28:01 +000037
38It is only with the input and contributions of the Python community
39that Python has such wonderful documentation -- Thank You!