diff --git a/docs/contents.rst.inc b/docs/contents.rst.inc index de51208ae..3f6f60a99 100644 --- a/docs/contents.rst.inc +++ b/docs/contents.rst.inc @@ -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 @@ -80,6 +79,7 @@ different scenarios. scenarios/admin scenarios/ci scenarios/speed + scenarios/scientific Additional Notes @@ -92,3 +92,4 @@ Contibution notes and legal information are here (for those interested). notes/contribute notes/license + notes/styleguide diff --git a/docs/notes/contribute.rst b/docs/notes/contribute.rst index 3caf7583e..0d709f29f 100644 --- a/docs/notes/contribute.rst +++ b/docs/notes/contribute.rst @@ -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 \ No newline at end of file diff --git a/docs/scenarios/gui.rst b/docs/scenarios/gui.rst index 8572f7b04..037c64150 100644 --- a/docs/scenarios/gui.rst +++ b/docs/scenarios/gui.rst @@ -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 -:: \ No newline at end of file +:: diff --git a/docs/scenarios/web.rst b/docs/scenarios/web.rst index 67f240f4d..294c205d0 100644 --- a/docs/scenarios/web.rst +++ b/docs/scenarios/web.rst @@ -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 `_ . + + Web Servers ::::::::::: @@ -312,4 +314,4 @@ Node.js. .. [1] `The mod_python project is now officially dead `_ .. [2] `mod_wsgi vs mod_python `_ -.. [3] `Benchmark of Python WSGI Servers `_ \ No newline at end of file +.. [3] `Benchmark of Python WSGI Servers `_ diff --git a/docs/starting/installation.rst b/docs/starting/installation.rst index ace753f08..e4890e346 100644 --- a/docs/starting/installation.rst +++ b/docs/starting/installation.rst @@ -65,10 +65,6 @@ If you have homebrew: :: $ easy_install pip - - -To install ``pip``: :: - Hopefully you'll never have to use **easy_install** again. diff --git a/docs/starting/next.rst b/docs/starting/next.rst deleted file mode 100644 index e69de29bb..000000000 diff --git a/docs/writing/documentation.rst b/docs/writing/documentation.rst index d1c4658c4..68246655d 100644 --- a/docs/writing/documentation.rst +++ b/docs/writing/documentation.rst @@ -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 ----- \ No newline at end of file +----