Skip to content

Commit 7f8ea77

Browse files
committed
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.
1 parent 739e831 commit 7f8ea77

File tree

2 files changed

+46
-4
lines changed

2 files changed

+46
-4
lines changed

coding.rst

+4-4
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ that the code is correct to the best of our knowledge. See
5151
:ref:`ci-chapter`.
5252

5353

54-
.. index:: code;style
54+
.. index:: code;python coding style
5555

5656
.. _python:
5757

@@ -89,7 +89,7 @@ Use single quotes unless you need double (or triple) quotes::
8989
.. _Pocoo: http://www.pocoo.org/internal/styleguide/
9090

9191

92-
.. index:: code;django tips
92+
.. index:: code;django coding style
9393

9494
Django
9595
------
@@ -129,7 +129,7 @@ See :ref:`packaging`.
129129

130130
.. _Playdoh: https://github.com/mozilla/playdoh
131131

132-
.. index:: code;javascript
132+
.. index:: code;javascript coding style
133133

134134
Javascript
135135
----------
@@ -145,7 +145,7 @@ Javascript
145145
.. _JSLint: http://www.jslint.com/
146146

147147

148-
.. index:: code;html5
148+
.. index:: code;html5 coding style
149149

150150
HTML
151151
----

documentation.rst

+42
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
Documentation
2+
=============
3+
4+
5+
.. index:: documentation;Python code, Restructured Text
6+
7+
Documenting Python
8+
------------------
9+
10+
Use `Restructured Text`_ and `PEP-257`_ for docstrings.
11+
12+
.. _Restructured Text: http://docutils.sourceforge.net/rst.html
13+
.. _PEP-257: http://www.python.org/dev/peps/pep-0257/
14+
15+
16+
.. index:: documentation;projects, Sphinx docs
17+
18+
Documenting projects
19+
--------------------
20+
21+
Use `Sphinx`_ to document Python projects.
22+
23+
When doing that, follow the `Restructured Text primer`_.
24+
25+
.. _Sphinx: http://sphinx.pocoo.org/
26+
.. _Restructured Text primer: http://sphinx.pocoo.org/rest.html
27+
28+
29+
.. index:: documentation;projects, Read The Docs
30+
31+
ReadTheDocs
32+
-----------
33+
34+
`Read The Docs <http://readthedocs.org/>`_ hosts documentation for
35+
applications and libraries written in Python.
36+
37+
The `Getting Started
38+
<http://readthedocs.org/docs/read-the-docs/en/latest/getting_started.html>`_
39+
walks through getting docs on the site.
40+
41+
You can also set up ReadTheDocs as a `post-commit hook in GitHub
42+
<http://readthedocs.org/docs/read-the-docs/en/latest/webhooks.html#github>`_.

0 commit comments

Comments
 (0)