rename resources and re-add Indices and tables to index

nebbles · Feb 13, 2018 · 3a3bf69 · 3a3bf69
1 parent 8022605
commit 3a3bf69
Show file tree

Hide file tree

Showing 2 changed files with 24 additions and 9 deletions.
diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -46,5 +46,12 @@ Contents
 
    project-proposal
    project-plan
-   documentation
+   resources
    ground-rules
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`
diff --git a/docs/source/documentation.rst → docs/source/resources.rst b/docs/source/documentation.rst → docs/source/resources.rst
@@ -10,20 +10,34 @@ GitHub and Git
 * The super simple beginners guide to Git: http://rogerdudler.github.io/git-guide/
 * Guidance to git commands you may need in the command line: https://www.git-tower.com/blog/git-cheat-sheet/
 
+Python
+======
+
 Structuring large Python projects
-=================================
+---------------------------------
 
 * Python documentation on what package, module, script are: https://docs.python.org/3/tutorial/modules.html
 * Simple example of this structure and how it is documented: https://github.com/brandon-rhodes/sphinx-tutorial/blob/master/triangle-project/trianglelib
 
 Writing Code: Python Conventions & Documentation
-================================================
+------------------------------------------------
 
 * Overall guide to documentation in Python http://docs.python-guide.org/en/latest/writing/documentation/
 * The PEP8 on writing your code keeping to convention (supported by PyCharm): https://www.python.org/dev/peps/pep-0008/
 * The PEP257 on documenting your code:  https://www.python.org/dev/peps/pep-0257/
 * Handling errors with exceptions and raising errors: https://docs.python.org/2/tutorial/errors.html
 
+Differences between Python 2 and Python 3
+-----------------------------------------
+
+* http://sebastianraschka.com/Articles/2014_python_2_3_key_diff.html
+* Porting code from Python 2 to Python 3: https://docs.python.org/3/howto/pyporting.html
+
+Python commands
+---------------
+
+* ``pyclean .`` will clean the current directory of \_pycache_ and .pyc
+
 reStructuredText & Sphinx Markup
 ================================
 
@@ -43,9 +57,3 @@ The following resources were useful in the setting up of Sphinx and Read The Doc
 * Screencast: https://www.youtube.com/watch?v=oJsUvBQyHBs
 * RTD Guide: https://docs.readthedocs.io/en/latest/getting_started.html
 * Documenting a project with Sphinx (lecture): https://www.youtube.com/watch?v=QNHM7q2hLh8
-
-Differences between Python 2 and Python 3
-=========================================
-
-* http://sebastianraschka.com/Articles/2014_python_2_3_key_diff.html
-* Porting code from Python 2 to Python 3: https://docs.python.org/3/howto/pyporting.html