Georg Brandl | 8ec7f65 | 2007-08-15 14:28:01 +0000 | [diff] [blame] | 1 | ===================== |
| 2 | About these documents |
| 3 | ===================== |
| 4 | |
| 5 | |
Georg Brandl | e11d85c | 2010-04-22 22:15:33 +0000 | [diff] [blame] | 6 | These documents are generated from `reStructuredText`_ sources by `Sphinx`_, a |
| 7 | document processor specifically written for the Python documentation. |
| 8 | |
| 9 | .. _reStructuredText: http://docutils.sf.net/rst.html |
| 10 | .. _Sphinx: http://sphinx.pocoo.org/ |
Georg Brandl | 8ec7f65 | 2007-08-15 14:28:01 +0000 | [diff] [blame] | 11 | |
Georg Brandl | c03cd4c | 2009-05-16 11:24:41 +0000 | [diff] [blame] | 12 | .. In the online version of these documents, you can submit comments and suggest |
| 13 | changes directly on the documentation pages. |
Georg Brandl | 8ec7f65 | 2007-08-15 14:28:01 +0000 | [diff] [blame] | 14 | |
| 15 | Development of the documentation and its toolchain takes place on the |
| 16 | docs@python.org mailing list. We're always looking for volunteers wanting |
| 17 | to help with the docs, so feel free to send a mail there! |
| 18 | |
| 19 | Many 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; |
David Goodger | 67ea002 | 2008-04-21 14:43:33 +0000 | [diff] [blame] | 23 | * the `Docutils <http://docutils.sf.net/>`_ project for creating |
| 24 | reStructuredText and the Docutils suite; |
Georg Brandl | 8ec7f65 | 2007-08-15 14:28:01 +0000 | [diff] [blame] | 25 | * 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 Brandl | c03cd4c | 2009-05-16 11:24:41 +0000 | [diff] [blame] | 29 | See :ref:`reporting-bugs` for information how to report bugs in this |
| 30 | documentation, or Python itself. |
Georg Brandl | 8ec7f65 | 2007-08-15 14:28:01 +0000 | [diff] [blame] | 31 | |
| 32 | .. including the ACKS file here so that it can be maintained separately |
| 33 | .. include:: ACKS.txt |
| 34 | |
| 35 | It is only with the input and contributions of the Python community |
| 36 | that Python has such wonderful documentation -- Thank You! |