mirror of
https://github.com/kennethreitz/python-guide.git
synced 2026-06-05 23:00:18 +00:00
A variety of build error fixes
This commit is contained in:
@@ -24,7 +24,6 @@ This part of the guide focuses on setting up your Python environment.
|
|||||||
|
|
||||||
starting/which-python
|
starting/which-python
|
||||||
starting/installation
|
starting/installation
|
||||||
starting/next
|
|
||||||
|
|
||||||
|
|
||||||
Development Environment
|
Development Environment
|
||||||
@@ -80,6 +79,7 @@ different scenarios.
|
|||||||
scenarios/admin
|
scenarios/admin
|
||||||
scenarios/ci
|
scenarios/ci
|
||||||
scenarios/speed
|
scenarios/speed
|
||||||
|
scenarios/scientific
|
||||||
|
|
||||||
|
|
||||||
Additional Notes
|
Additional Notes
|
||||||
@@ -92,3 +92,4 @@ Contibution notes and legal information are here (for those interested).
|
|||||||
|
|
||||||
notes/contribute
|
notes/contribute
|
||||||
notes/license
|
notes/license
|
||||||
|
notes/styleguide
|
||||||
|
|||||||
@@ -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/
|
.. _GitHub: http://github.com/kennethreitz/python-guide/
|
||||||
.. _todo: https://github.com/kennethreitz/python-guide/blob/master/TODO.rst
|
.. _todo: https://github.com/kennethreitz/python-guide/blob/master/TODO.rst
|
||||||
|
|
||||||
.. include:: ../../AUTHORS.rst
|
|
||||||
@@ -26,12 +26,14 @@ PyObjC
|
|||||||
|
|
||||||
WXPython
|
WXPython
|
||||||
::::::::
|
::::::::
|
||||||
|
|
||||||
|
|
||||||
Install (Stable)
|
Install (Stable)
|
||||||
----
|
----------------
|
||||||
*Go to http://www.wxpython.org/download.php#stable and download the appropriate package for your OS.*
|
*Go to http://www.wxpython.org/download.php#stable and download the appropriate package for your OS.*
|
||||||
|
|
||||||
Gtk
|
Gtk
|
||||||
:::
|
:::
|
||||||
|
|
||||||
tk
|
tk
|
||||||
::
|
::
|
||||||
|
|||||||
@@ -65,10 +65,6 @@ If you have homebrew: ::
|
|||||||
|
|
||||||
$ easy_install pip
|
$ easy_install pip
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
To install ``pip``: ::
|
|
||||||
|
|
||||||
Hopefully you'll never have to use **easy_install** again.
|
Hopefully you'll never have to use **easy_install** again.
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
@@ -11,6 +11,7 @@ The Basics
|
|||||||
|
|
||||||
Code Comments
|
Code Comments
|
||||||
-------------
|
-------------
|
||||||
|
|
||||||
Information regarding code comments is taken from PEP 008 (http://www.python.org/dev/peps/pep-0008/).
|
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.: ::
|
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
|
Doc Strings
|
||||||
-----------
|
-----------
|
||||||
|
|
||||||
PEP 257 is the primary reference for docstrings. (http://www.python.org/dev/peps/pep-0257/)
|
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():
|
def kos_root():
|
||||||
"""Return the pathname of the KOS root directory."""
|
"""Return the pathname of the KOS root directory."""
|
||||||
@@ -59,6 +62,7 @@ Multi-line docstrings: ::
|
|||||||
|
|
||||||
Sphinx
|
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.
|
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_
|
.. 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-ref:
|
||||||
|
|
||||||
|
|
||||||
reStructuredText
|
reStructuredText
|
||||||
----------------
|
----------------
|
||||||
|
|
||||||
@@ -84,4 +89,4 @@ pocco / docco / shocco
|
|||||||
----------------------
|
----------------------
|
||||||
|
|
||||||
Ronn
|
Ronn
|
||||||
----
|
----
|
||||||
|
|||||||
Reference in New Issue
Block a user