File tree 2 files changed +46
-4
lines changed
2 files changed +46
-4
lines changed Original file line number Diff line number Diff line change @@ -51,7 +51,7 @@ that the code is correct to the best of our knowledge. See
51
51
:ref: `ci-chapter `.
52
52
53
53
54
- .. index :: code;style
54
+ .. index :: code;python coding style
55
55
56
56
.. _python :
57
57
@@ -89,7 +89,7 @@ Use single quotes unless you need double (or triple) quotes::
89
89
.. _Pocoo : http://www.pocoo.org/internal/styleguide/
90
90
91
91
92
- .. index :: code;django tips
92
+ .. index :: code;django coding style
93
93
94
94
Django
95
95
------
@@ -129,7 +129,7 @@ See :ref:`packaging`.
129
129
130
130
.. _Playdoh : https://github.com/mozilla/playdoh
131
131
132
- .. index :: code;javascript
132
+ .. index :: code;javascript coding style
133
133
134
134
Javascript
135
135
----------
@@ -145,7 +145,7 @@ Javascript
145
145
.. _JSLint : http://www.jslint.com/
146
146
147
147
148
- .. index :: code;html5
148
+ .. index :: code;html5 coding style
149
149
150
150
HTML
151
151
----
Original file line number Diff line number Diff line change
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> `_.
You can’t perform that action at this time.
0 commit comments