Commit 8a8a6c7
File tree
- docs
- notes
- scenarios
- starting
- writing
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -24,7 +24,6 @@ This part of the guide focuses on setting up your Python environment. | |||
| 24 | 24 | ||
| 25 | 25 | starting/which-python | |
| 26 | 26 | starting/installation | |
| 27 | - starting/next | ||
| 28 | 27 | ||
| 29 | 28 | ||
| 30 | 29 | Development Environment | |
@@ -80,6 +79,7 @@ different scenarios. | |||
| 80 | 79 | scenarios/admin | |
| 81 | 80 | scenarios/ci | |
| 82 | 81 | scenarios/speed | |
| 82 | + scenarios/scientific | ||
| 83 | 83 | ||
| 84 | 84 | ||
| 85 | 85 | Additional Notes | |
@@ -92,3 +92,4 @@ Contibution notes and legal information are here (for those interested). | |||
| 92 | 92 | ||
| 93 | 93 | notes/contribute | |
| 94 | 94 | notes/license | |
| 95 | + notes/styleguide | ||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -25,5 +25,3 @@ If you'd like to contribute, there's plenty to do. Here's a short todo_ list. | |||
| 25 | 25 | ||
| 26 | 26 | .. _GitHub: http://github.com/kennethreitz/python-guide/ | |
| 27 | 27 | .. _todo: https://github.com/kennethreitz/python-guide/blob/master/TODO.rst | |
| 28 | - | ||
| 29 | - .. include:: ../../AUTHORS.rst | ||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -26,12 +26,14 @@ PyObjC | |||
| 26 | 26 | ||
| 27 | 27 | WXPython | |
| 28 | 28 | :::::::: | |
| 29 | + | ||
| 30 | + | ||
| 29 | 31 | Install (Stable) | |
| 30 | - ---- | ||
| 32 | + ---------------- | ||
| 31 | 33 | *Go to http://www.wxpython.org/download.php#stable and download the appropriate package for your OS.* | |
| 32 | 34 | ||
| 33 | 35 | Gtk | |
| 34 | 36 | ::: | |
| 35 | 37 | ||
| 36 | 38 | tk | |
| 37 | - :: | ||
| 39 | + :: | ||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -65,10 +65,6 @@ If you have homebrew: :: | |||
| 65 | 65 | ||
| 66 | 66 | $ easy_install pip | |
| 67 | 67 | ||
| 68 | - | ||
| 69 | - | ||
| 70 | - To install ``pip``: :: | ||
| 71 | - | ||
| 72 | 68 | Hopefully you'll never have to use **easy_install** again. | |
| 73 | 69 | ||
| 74 | 70 | ||
Whitespace-only changes.
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -11,6 +11,7 @@ The Basics | |||
| 11 | 11 | ||
| 12 | 12 | Code Comments | |
| 13 | 13 | ------------- | |
| 14 | + | ||
| 14 | 15 | Information regarding code comments is taken from PEP 008 (http://www.python.org/dev/peps/pep-0008/). | |
| 15 | 16 | Block comment styling should be used when commenting out multiple lines of code.: :: | |
| 16 | 17 | ||
@@ -34,9 +35,11 @@ Inline comments are used for individual lines and should be used sparingly.: :: | |||
| 34 | 35 | ||
| 35 | 36 | Doc Strings | |
| 36 | 37 | ----------- | |
| 38 | + | ||
| 37 | 39 | 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: :: | ||
| 40 | 43 | ||
| 41 | 44 | def kos_root(): | |
| 42 | 45 | """Return the pathname of the KOS root directory.""" | |
@@ -59,6 +62,7 @@ Multi-line docstrings: :: | |||
| 59 | 62 | ||
| 60 | 63 | Sphinx | |
| 61 | 64 | ------ | |
| 65 | + | ||
| 62 | 66 | 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. | |
| 63 | 67 | ||
| 64 | 68 | .. note:: This Guide is built with Sphinx_ | |
@@ -67,6 +71,7 @@ Sphinx_ is a tool which converts documentation in the :ref:`restructuredtext-ref | |||
| 67 | 71 | ||
| 68 | 72 | .. _restructuredtext-ref: | |
| 69 | 73 | ||
| 74 | + | ||
| 70 | 75 | reStructuredText | |
| 71 | 76 | ---------------- | |
| 72 | 77 | ||
@@ -84,4 +89,4 @@ pocco / docco / shocco | |||
| 84 | 89 | ---------------------- | |
| 85 | 90 | ||
| 86 | 91 | Ronn | |
| 87 | - ---- | ||
| 92 | + ---- | ||
0 commit comments