kennethreitz/python-guide
1
0
Fork 0
mirror of https://github.com/kennethreitz/python-guide.git synced 2026-06-05 23:00:18 +00:00
Code Issues Packages Projects Releases Wiki Activity

First pass at styleguide

Browse Source
This commit is contained in:
Mike Thornton
2011-12-30 16:36:19 -06:00
parent 1df22ab2dc
commit 909bd39635
6 changed files with 153 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/writing/documentation.rst
+12 -1
View File
@@ -59,9 +59,20 @@ Multi-line docstrings: ::
Sphinx
------
Sphinx (http://sphinx.pocoo.org) is a tool which converts documentation in the reStructured text markup language into a range of output formats including HTML, LaTeX (for printable PDF versions), manual pages and plain text.
Sphinx_ is a tool which converts documentation in the :ref:`restructuredtext-ref` markup language into a range of output formats including HTML, LaTeX (for printable PDF versions), manual pages and plain text.
.. note:: This Guide is built with Sphinx_
.. _Sphinx: http://sphinx.pocoo.org
.. _restructuredtext-ref:
reStructuredText
----------------
Most Python documentation is written with reStructuredText_. The `reStructuredText Primer <http://sphinx.pocoo.org/rest.html>`_ and the `reStructuredText Quick Reference <http://docutils.sourceforge.net/docs/user/rst/quickref.html>`_ should help you familiarize yourself with its syntax.
.. _reStructuredText: http://docutils.sourceforge.net/rst.html
Other Tools
:::::::::::