/Doc/documenting/index.rst

http://unladen-swallow.googlecode.com/ · ReStructuredText · 32 lines · 24 code · 8 blank · 0 comment · 0 complexity · 04e4366b002f2cecae3e53cf677ca734 MD5 · raw file

  1. .. _documenting-index:
  2. ######################
  3. Documenting Python
  4. ######################
  5. The Python language has a substantial body of documentation, much of it
  6. contributed by various authors. The markup used for the Python documentation is
  7. `reStructuredText`_, developed by the `docutils`_ project, amended by custom
  8. directives and using a toolset named `Sphinx`_ to postprocess the HTML output.
  9. This document describes the style guide for our documentation, the custom
  10. reStructuredText markup introduced to support Python documentation and how it
  11. should be used, as well as the Sphinx build system.
  12. .. _reStructuredText: http://docutils.sf.net/rst.html
  13. .. _docutils: http://docutils.sf.net/
  14. .. _Sphinx: http://sphinx.pocoo.org/
  15. If you're interested in contributing to Python's documentation, there's no need
  16. to write reStructuredText if you're not so inclined; plain text contributions
  17. are more than welcome as well.
  18. .. toctree::
  19. :numbered:
  20. intro.rst
  21. style.rst
  22. rest.rst
  23. markup.rst
  24. fromlatex.rst