PageRenderTime 23ms CodeModel.GetById 15ms app.highlight 4ms RepoModel.GetById 1ms app.codeStats 1ms

/Doc/documenting/intro.rst

http://unladen-swallow.googlecode.com/
ReStructuredText | 29 lines | 25 code | 4 blank | 0 comment | 0 complexity | 715b50d1b2d4882470db761da1afca30 MD5 | raw file
 1Introduction
 2============
 3
 4Python's documentation has long been considered to be good for a free
 5programming language.  There are a number of reasons for this, the most
 6important being the early commitment of Python's creator, Guido van Rossum, to
 7providing documentation on the language and its libraries, and the continuing
 8involvement of the user community in providing assistance for creating and
 9maintaining documentation.
10
11The involvement of the community takes many forms, from authoring to bug reports
12to just plain complaining when the documentation could be more complete or
13easier to use.
14
15This document is aimed at authors and potential authors of documentation for
16Python.  More specifically, it is for people contributing to the standard
17documentation and developing additional documents using the same tools as the
18standard documents.  This guide will be less useful for authors using the Python
19documentation tools for topics other than Python, and less useful still for
20authors not using the tools at all.
21
22If your interest is in contributing to the Python documentation, but you don't
23have the time or inclination to learn reStructuredText and the markup structures
24documented here, there's a welcoming place for you among the Python contributors
25as well.  Any time you feel that you can clarify existing documentation or
26provide documentation that's missing, the existing documentation team will
27gladly work with you to integrate your text, dealing with the markup for you.
28Please don't let the material in this document stand between the documentation
29and your desire to help out!