Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion docs/contents.rst.inc
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,6 @@ This part of the guide focuses on setting up your Python environment.

starting/which-python
starting/installation
starting/next


Development Environment
Expand Down Expand Up @@ -80,6 +79,7 @@ different scenarios.
scenarios/admin
scenarios/ci
scenarios/speed
scenarios/scientific


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

notes/contribute
notes/license
notes/styleguide
2 changes: 0 additions & 2 deletions docs/notes/contribute.rst
Original file line number Diff line number Diff line change
Expand Up @@ -25,5 +25,3 @@ If you'd like to contribute, there's plenty to do. Here's a short todo_ list.

.. _GitHub: http://github.com/kennethreitz/python-guide/
.. _todo: https://github.com/kennethreitz/python-guide/blob/master/TODO.rst

.. include:: ../../AUTHORS.rst
6 changes: 4 additions & 2 deletions docs/scenarios/gui.rst
Original file line number Diff line number Diff line change
Expand Up @@ -26,12 +26,14 @@ PyObjC

WXPython
::::::::


Install (Stable)
----
----------------
*Go to http://www.wxpython.org/download.php#stable and download the appropriate package for your OS.*

Gtk
:::

tk
::
::
4 changes: 3 additions & 1 deletion docs/scenarios/web.rst
Original file line number Diff line number Diff line change
Expand Up @@ -88,6 +88,8 @@ The premise of web.py is that it is flexible - code your webapp any way you want
web.py comes with some nifty tools built in, like database connection tools and a mini http server.

**Support** for web.py is quite sparse, but you can look for support in the `mailing list <http://groups.google.com/group/webpy>`_ .


Web Servers
:::::::::::

Expand Down Expand Up @@ -312,4 +314,4 @@ Node.js.

.. [1] `The mod_python project is now officially dead <http://blog.dscpl.com.au/2010/06/modpython-project-is-now-officially.html>`_
.. [2] `mod_wsgi vs mod_python <http://www.modpython.org/pipermail/mod_python/2007-July/024080.html>`_
.. [3] `Benchmark of Python WSGI Servers <http://nichol.as/benchmark-of-python-web-servers>`_
.. [3] `Benchmark of Python WSGI Servers <http://nichol.as/benchmark-of-python-web-servers>`_
4 changes: 0 additions & 4 deletions docs/starting/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -65,10 +65,6 @@ If you have homebrew: ::

$ easy_install pip



To install ``pip``: ::

Hopefully you'll never have to use **easy_install** again.


Expand Down
Empty file removed docs/starting/next.rst
Empty file.
11 changes: 8 additions & 3 deletions docs/writing/documentation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ The Basics

Code Comments
-------------

Information regarding code comments is taken from PEP 008 (http://www.python.org/dev/peps/pep-0008/).
Block comment styling should be used when commenting out multiple lines of code.: ::

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

Doc Strings
-----------

PEP 257 is the primary reference for docstrings. (http://www.python.org/dev/peps/pep-0257/)
|There are two types of docstrings, one-line and multi-line. Their names should be fairly self explanatory.
|One-line docstrings: ::

There are two types of docstrings, one-line and multi-line. Their names should be fairly self explanatory.
One-line docstrings: ::

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

Sphinx
------

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_
Expand All @@ -67,6 +71,7 @@ Sphinx_ is a tool which converts documentation in the :ref:`restructuredtext-ref

.. _restructuredtext-ref:


reStructuredText
----------------

Expand All @@ -84,4 +89,4 @@ pocco / docco / shocco
----------------------

Ronn
----
----