improved docs

SpectoLabs · Dec 5, 2016 · 9029038 · 9029038
1 parent 562dba8
commit 9029038
Show file tree

Hide file tree

Showing 24 changed files with 151 additions and 492 deletions.
diff --git a/docs/source/basic.rst b/docs/source/basic.rst
@@ -1,4 +1,4 @@
-.. _basic
+.. basic
 
 =====
 basic
@@ -40,3 +40,7 @@ Print the json from our get request. This time the data comes from the store.
 >>>     print(requests.get("http://ip.jsontest.com/myip").json())
 
 
+Requests.db
+-----------
+
+You may have noticed this created a ``requests.db`` inside your current directory. This is a boltdb database, holding our requests, and their responses. 
diff --git a/docs/source/delays.rst b/docs/source/delays.rst
@@ -1,4 +1,4 @@
-.. _delays
+.. delays
 
 ======
 delays

diff --git a/docs/source/examples.rst b/docs/source/examples.rst
diff --git a/docs/source/hoverpy.tests.modify.rst b/docs/source/hoverpy.tests.modify.rst
@@ -0,0 +1,30 @@
+hoverpy.tests.modify package
+============================
+
+Submodules
+----------
+
+hoverpy.tests.modify.modify module
+----------------------------------
+
+.. automodule:: hoverpy.tests.modify.modify
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+hoverpy.tests.modify.test_modify module
+---------------------------------------
+
+.. automodule:: hoverpy.tests.modify.test_modify
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+
+Module contents
+---------------
+
+.. automodule:: hoverpy.tests.modify
+    :members:
+    :undoc-members:
+    :show-inheritance:
diff --git a/docs/source/hoverpy.tests.rst b/docs/source/hoverpy.tests.rst
@@ -0,0 +1,46 @@
+hoverpy.tests package
+=====================
+
+Subpackages
+-----------
+
+.. toctree::
+
+    hoverpy.tests.modify
+    hoverpy.tests.templates
+
+Submodules
+----------
+
+hoverpy.tests.basetestcase module
+---------------------------------
+
+.. automodule:: hoverpy.tests.basetestcase
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+hoverpy.tests.run module
+------------------------
+
+.. automodule:: hoverpy.tests.run
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+hoverpy.tests.test_virtualisation module
+----------------------------------------
+
+.. automodule:: hoverpy.tests.test_virtualisation
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+
+Module contents
+---------------
+
+.. automodule:: hoverpy.tests
+    :members:
+    :undoc-members:
+    :show-inheritance:
diff --git a/docs/source/hoverpy.tests.templates.rst b/docs/source/hoverpy.tests.templates.rst
@@ -0,0 +1,22 @@
+hoverpy.tests.templates package
+===============================
+
+Submodules
+----------
+
+hoverpy.tests.templates.test_templates module
+---------------------------------------------
+
+.. automodule:: hoverpy.tests.templates.test_templates
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+
+Module contents
+---------------
+
+.. automodule:: hoverpy.tests.templates
+    :members:
+    :undoc-members:
+    :show-inheritance:
diff --git a/docs/source/modify.rst b/docs/source/modify.rst
@@ -1,4 +1,4 @@
-.. _modify
+.. modify
 
 ======
 modify

diff --git a/docs/source/readthedocs.rst b/docs/source/readthedocs.rst
@@ -1,4 +1,4 @@
-.. _readthedocs
+.. readthedocs
 
 ===========
 readthedocs

diff --git a/docs/source/unittesting.rst b/docs/source/unittesting.rst
@@ -1,4 +1,4 @@
-.. _unittesting
+.. unittesting
 
 ===========
 unittesting
@@ -46,4 +46,12 @@ Let's run our hoverpy testcase if the script is invoked directly
 >>>     unittest.main()
 
 
-<hr> Now the correct way of launching this script the first time is: <br><br> `$ env HOVERPY_CAPTURE=true python examples/unittesting/unittesting.py`<br><br> which sets HoverPy in capture mode, and creates our all important `requests.db`. This process may take around 10 seconds depending on your internet speed. Now when we rerun our unit tests, we're always running against the data we captured in `requests.db`.<br><br> `$ python examples/unittesting/unittesting.py`<br><br> This time we are done in around 100ms! Not to mention: no more unnecessary breakages. 
+Now the correct way of launching this script the first time is: 
+
+``$ env HOVERPY_CAPTURE=true python examples/unittesting/unittesting.py``
+
+which sets HoverPy in capture mode, and creates our all important ``requests.db``. This process may take around 10 seconds depending on your internet speed. Now when we rerun our unit tests, we're always running against the data we captured in ``requests.db``.
+
+``$ python examples/unittesting/unittesting.py``
+
+This time we are done in around 100ms! Not to mention: no more unnecessary breakages. 
diff --git a/docs/source/urllib2eg.rst b/docs/source/urllib2eg.rst
@@ -1,4 +1,4 @@
-.. _urllib2eg
+.. urllib2eg
 
 =========
 urllib2eg

diff --git a/docs/source/urllib3eg.rst b/docs/source/urllib3eg.rst
@@ -1,4 +1,4 @@
-.. _urllib3eg
+.. urllib3eg
 
 =========
 urllib3eg

diff --git a/docs/source/usage.rst b/docs/source/usage.rst
@@ -15,8 +15,4 @@ I don't know about you, but for me the best way of getting into things is by try
    urllib3eg
 
 
-requests.db
------------
-
-You may have noticed this created a ``requests.db`` inside your current directory. This is a boltdb database, holding our requests, and their responses.
 
diff --git a/examples/basic/basic.py b/examples/basic/basic.py
@@ -19,3 +19,11 @@
     # print the json from our get request. This time the data comes from the
     # store.
     print(requests.get("http://ip.jsontest.com/myip").json())
+
+
+# requests.db<br>
+# -----------<br>
+# <br>
+# You may have noticed this created a ``requests.db`` inside your current
+# directory. This is a boltdb database, holding our requests, and their
+# responses.
diff --git a/examples/basic/basic.rst b/examples/basic/basic.rst
diff --git a/examples/delays/delays.rst b/examples/delays/delays.rst