A variety of build error fixes

This commit is contained in:
Kamil Kisiel
2012-01-02 06:26:12 -08:00
parent f4918a569c
commit 8a8a6c794f
6 changed files with 14 additions and 12 deletions
+8 -3
View File
@@ -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.: ::
@@ -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."""
@@ -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_
@@ -67,6 +71,7 @@ Sphinx_ is a tool which converts documentation in the :ref:`restructuredtext-ref
.. _restructuredtext-ref:
reStructuredText
----------------
@@ -84,4 +89,4 @@ pocco / docco / shocco
----------------------
Ronn
----
----