7. Documenting Python — Python Developer's Guide. The Python language has a substantial body of documentation, much of it contributed by various authors. The markup used for the Python documentation is reStructuredText, developed by the docutils project, amended by custom directives and using a toolset named Sphinx to post-process the HTML output. This document describes the style guide for our documentation as well as the custom reStructuredText markup introduced by Sphinx to support Python documentation and how it should be used. 7.1.
Introduction Python’s documentation has long been considered to be good for a free programming language. The involvement of the community takes many forms, from authoring to bug reports to just plain complaining when the documentation could be more complete or easier to use. This document is aimed at authors and potential authors of documentation for Python. 7.2. 7.2.1. All reST files use an indentation of 3 spaces; no tabs are allowed. 7.2.3. Note For “central processing unit.” Python reST Unicode Unix 7.2.4. Comparison of documentation generators. The following tables compare general and technical information for a number of documentation generators. Please see the individual products' articles for further information. Unless otherwise specified in footnotes, comparisons are based on the stable versions without any add-ons, extensions or external programs.
General information[edit] Basic general information about the generators: creator/company, license/price etc. Operating system support[edit] The operating systems the generators can run on. Note (4): GNU D Compiler. Language support[edit] The programming languages the generators recognize. Note (1): .NET is not a programming language, but is listed here for convenience. Note (2): Though not supported as a native input language, Doxygen can be extended through the use of filters. Note (3): Generators listed here can be extended to support any language that has comments. Input formats[edit] The input formats the generators can read. Output formats[edit] Other features[edit] GhostDoc. ReText / Home / ReText. Overview — Sphinx 1.1.3 documentation.