Skip to content

Commit cb34caf

Browse files
author
Kenneth Reitz
committed
Merge pull request realpython#69 from kisielk/web_fix
A variety of minor cleanups and fixes
2 parents c7f2c28 + 8a8a6c7 commit cb34caf

File tree

7 files changed

+17
-13
lines changed

7 files changed

+17
-13
lines changed

docs/contents.rst.inc

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,6 @@ This part of the guide focuses on setting up your Python environment.
2424

2525
starting/which-python
2626
starting/installation
27-
starting/next
2827

2928

3029
Development Environment
@@ -80,6 +79,7 @@ different scenarios.
8079
scenarios/admin
8180
scenarios/ci
8281
scenarios/speed
82+
scenarios/scientific
8383

8484

8585
Additional Notes
@@ -92,3 +92,4 @@ Contibution notes and legal information are here (for those interested).
9292

9393
notes/contribute
9494
notes/license
95+
notes/styleguide

docs/notes/contribute.rst

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,5 +25,3 @@ If you'd like to contribute, there's plenty to do. Here's a short todo_ list.
2525

2626
.. _GitHub: http://github.com/kennethreitz/python-guide/
2727
.. _todo: https://github.com/kennethreitz/python-guide/blob/master/TODO.rst
28-
29-
.. include:: ../../AUTHORS.rst

docs/scenarios/gui.rst

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -26,12 +26,14 @@ PyObjC
2626

2727
WXPython
2828
::::::::
29+
30+
2931
Install (Stable)
30-
----
32+
----------------
3133
*Go to http://www.wxpython.org/download.php#stable and download the appropriate package for your OS.*
3234

3335
Gtk
3436
:::
3537

3638
tk
37-
::
39+
::

docs/scenarios/web.rst

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -88,6 +88,8 @@ The premise of web.py is that it is flexible - code your webapp any way you want
8888
web.py comes with some nifty tools built in, like database connection tools and a mini http server.
8989

9090
**Support** for web.py is quite sparse, but you can look for support in the `mailing list <http://groups.google.com/group/webpy>`_ .
91+
92+
9193
Web Servers
9294
:::::::::::
9395

@@ -312,4 +314,4 @@ Node.js.
312314

313315
.. [1] `The mod_python project is now officially dead <http://blog.dscpl.com.au/2010/06/modpython-project-is-now-officially.html>`_
314316
.. [2] `mod_wsgi vs mod_python <http://www.modpython.org/pipermail/mod_python/2007-July/024080.html>`_
315-
.. [3] `Benchmark of Python WSGI Servers <http://nichol.as/benchmark-of-python-web-servers>`_
317+
.. [3] `Benchmark of Python WSGI Servers <http://nichol.as/benchmark-of-python-web-servers>`_

docs/starting/installation.rst

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -65,10 +65,6 @@ If you have homebrew: ::
6565

6666
$ easy_install pip
6767

68-
69-
70-
To install ``pip``: ::
71-
7268
Hopefully you'll never have to use **easy_install** again.
7369

7470

docs/starting/next.rst

Whitespace-only changes.

docs/writing/documentation.rst

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@ The Basics
1111

1212
Code Comments
1313
-------------
14+
1415
Information regarding code comments is taken from PEP 008 (http://www.python.org/dev/peps/pep-0008/).
1516
Block comment styling should be used when commenting out multiple lines of code.: ::
1617

@@ -34,9 +35,11 @@ Inline comments are used for individual lines and should be used sparingly.: ::
3435

3536
Doc Strings
3637
-----------
38+
3739
PEP 257 is the primary reference for docstrings. (http://www.python.org/dev/peps/pep-0257/)
38-
|There are two types of docstrings, one-line and multi-line. Their names should be fairly self explanatory.
39-
|One-line docstrings: ::
40+
41+
There are two types of docstrings, one-line and multi-line. Their names should be fairly self explanatory.
42+
One-line docstrings: ::
4043

4144
def kos_root():
4245
"""Return the pathname of the KOS root directory."""
@@ -59,6 +62,7 @@ Multi-line docstrings: ::
5962

6063
Sphinx
6164
------
65+
6266
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.
6367

6468
.. note:: This Guide is built with Sphinx_
@@ -67,6 +71,7 @@ Sphinx_ is a tool which converts documentation in the :ref:`restructuredtext-ref
6771

6872
.. _restructuredtext-ref:
6973

74+
7075
reStructuredText
7176
----------------
7277

@@ -84,4 +89,4 @@ pocco / docco / shocco
8489
----------------------
8590

8691
Ronn
87-
----
92+
----

0 commit comments

Comments
 (0)