blob: 2c229e662c42de13cf4ddc24f7c895a3ebddc324 [file] [log] [blame]
Georg Brandl116aa622007-08-15 14:28:22 +00001=====================
2About these documents
3=====================
4
5
Georg Brandl582c0a62010-04-22 23:20:19 +00006These documents are generated from `reStructuredText`_ sources by `Sphinx`_, a
7document processor specifically written for the Python documentation.
8
9.. _reStructuredText: http://docutils.sf.net/rst.html
10.. _Sphinx: http://sphinx.pocoo.org/
Georg Brandl116aa622007-08-15 14:28:22 +000011
Georg Brandl8a1e4c42009-05-25 21:13:36 +000012.. In the online version of these documents, you can submit comments and suggest
13 changes directly on the documentation pages.
Georg Brandl116aa622007-08-15 14:28:22 +000014
15Development of the documentation and its toolchain takes place on the
16docs@python.org mailing list. We're always looking for volunteers wanting
17to help with the docs, so feel free to send a mail there!
18
19Many thanks go to:
20
21* Fred L. Drake, Jr., the creator of the original Python documentation toolset
22 and writer of much of the content;
Christian Heimes81ee3ef2008-05-04 22:42:01 +000023* the `Docutils <http://docutils.sf.net/>`_ project for creating
24 reStructuredText and the Docutils suite;
Georg Brandl116aa622007-08-15 14:28:22 +000025* Fredrik Lundh for his `Alternative Python Reference
26 <http://effbot.org/zone/pyref.htm>`_ project from which Sphinx got many good
27 ideas.
28
Georg Brandl8a1e4c42009-05-25 21:13:36 +000029See :ref:`reporting-bugs` for information how to report bugs in this
30documentation, or Python itself.
Georg Brandl116aa622007-08-15 14:28:22 +000031
32.. including the ACKS file here so that it can be maintained separately
33.. include:: ACKS.txt
34
35It is only with the input and contributions of the Python community
36that Python has such wonderful documentation -- Thank You!