Permalink
Browse files

Tweak indexes; add documentation chapter

* Adds "coding style" to the end of index names so it's clearer from the
  index what it links to.
* Adds documentation chapter.
  • Loading branch information...
1 parent 739e831 commit 7f8ea771a458ff1040625f1987aa775338bb4598 @willkg willkg committed Sep 14, 2011
Showing with 46 additions and 4 deletions.
  1. +4 −4 coding.rst
  2. +42 −0 documentation.rst
View
@@ -51,7 +51,7 @@ that the code is correct to the best of our knowledge. See
:ref:`ci-chapter`.
-.. index:: code;style
+.. index:: code;python coding style
.. _python:
@@ -89,7 +89,7 @@ Use single quotes unless you need double (or triple) quotes::
.. _Pocoo: http://www.pocoo.org/internal/styleguide/
-.. index:: code;django tips
+.. index:: code;django coding style
Django
------
@@ -129,7 +129,7 @@ See :ref:`packaging`.
.. _Playdoh: https://github.com/mozilla/playdoh
-.. index:: code;javascript
+.. index:: code;javascript coding style
Javascript
----------
@@ -145,7 +145,7 @@ Javascript
.. _JSLint: http://www.jslint.com/
-.. index:: code;html5
+.. index:: code;html5 coding style
HTML
----
View
@@ -0,0 +1,42 @@
+Documentation
+=============
+
+
+.. index:: documentation;Python code, Restructured Text
+
+Documenting Python
+------------------
+
+Use `Restructured Text`_ and `PEP-257`_ for docstrings.
+
+.. _Restructured Text: http://docutils.sourceforge.net/rst.html
+.. _PEP-257: http://www.python.org/dev/peps/pep-0257/
+
+
+.. index:: documentation;projects, Sphinx docs
+
+Documenting projects
+--------------------
+
+Use `Sphinx`_ to document Python projects.
+
+When doing that, follow the `Restructured Text primer`_.
+
+.. _Sphinx: http://sphinx.pocoo.org/
+.. _Restructured Text primer: http://sphinx.pocoo.org/rest.html
+
+
+.. index:: documentation;projects, Read The Docs
+
+ReadTheDocs
+-----------
+
+`Read The Docs <http://readthedocs.org/>`_ hosts documentation for
+applications and libraries written in Python.
+
+The `Getting Started
+<http://readthedocs.org/docs/read-the-docs/en/latest/getting_started.html>`_
+walks through getting docs on the site.
+
+You can also set up ReadTheDocs as a `post-commit hook in GitHub
+<http://readthedocs.org/docs/read-the-docs/en/latest/webhooks.html#github>`_.

0 comments on commit 7f8ea77

Please sign in to comment.