udpated documentation

SpectoLabs · Dec 1, 2016 · 1d6defd · 1d6defd
1 parent cebafba
commit 1d6defd
Show file tree

Hide file tree

Showing 16 changed files with 37 additions and 55 deletions.
diff --git a/docs/source/basic.rst b/docs/source/basic.rst
@@ -1,6 +1,6 @@
 .. basic
 
-Basic
+basic
 ********
 
 

diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -118,9 +118,10 @@
 
 # -- Options for HTML output ----------------------------------------------
 
-# The theme to use for HTML and HTML Help pages.  See the documentation for
-# a list of builtin themes.
-html_theme = 'alabaster'
+if 'READTHEDOCS' not in os.environ:
+    import sphinx_rtd_theme
+    html_theme = 'sphinx_rtd_theme'
+    html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
 
 # Theme options are theme-specific and customize the look and feel of a theme
 # further.  For a list of options available for each theme, see the

diff --git a/docs/source/delays.rst b/docs/source/delays.rst
@@ -4,7 +4,8 @@ delays
 ********
 
 
-Import hoverpy's main class: HoverPy
+Demonstrates how to add latency to calls, based on host, and method
+type. import hoverpy's main class: HoverPy
 
 .. code:: python
 

diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -9,8 +9,8 @@ Contents
 .. toctree::
    :maxdepth: 2
 
-   installation.rst
-   usage.rst
+   installation
+   usage
 
 ==================
 Indices and tables

diff --git a/docs/source/installation.rst b/docs/source/installation.rst
@@ -1,7 +1,7 @@
 .. installation
 
 Installation
-------------
+============
 
 If you plan on trying out the examples:
 

diff --git a/docs/source/modify.rst b/docs/source/modify.rst
@@ -4,7 +4,9 @@ modify
 ********
 
 
-Import hoverpy's main class: HoverPy
+Demonstrates how to modify requests. This is particularly useful for
+sending curved balls to your applications, and make sure they deal with
+them correctly. import hoverpy's main class: HoverPy
 
 .. code:: python
 

diff --git a/docs/source/readthedocs.rst b/docs/source/readthedocs.rst
@@ -4,7 +4,10 @@ readthedocs
 ********
 
 
-Import hoverpy's main class: HoverPy
+Slightly more advanced example, where we query readthedocs.io for
+articles, get these articles. The program can be run in capture or
+simulate mode, and the functionality is timed. import hoverpy's main
+class: HoverPy
 
 .. code:: python
 

diff --git a/docs/source/usage.rst b/docs/source/usage.rst
@@ -1,4 +1,4 @@
-usage
+Usage
 =====
 
 .. include:: basic.rst
@@ -8,10 +8,18 @@ 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.
 
+----------------------------------------
+
 .. include:: readthedocs.rst
 
+----------------------------------------
+
 .. include:: unittesting.rst
 
+----------------------------------------
+
 .. include:: delays.rst
 
+----------------------------------------
+
 .. include:: modify.rst
diff --git a/examples/README.md b/examples/README.md
diff --git a/examples/delays/README.md b/examples/delays/README.md
@@ -1,4 +1,4 @@
-Import hoverpy's main class: HoverPy 
+Demonstrates how to add latency to calls, based on host, and method type. import hoverpy's main class: HoverPy 
 
 ```python
 from hoverpy import HoverPy

diff --git a/examples/delays/delays.py b/examples/delays/delays.py
@@ -1,3 +1,4 @@
+# Demonstrates how to add latency to calls, based on host, and method type.
 # import hoverpy's main class: HoverPy
 from hoverpy import HoverPy
 

diff --git a/examples/modify/README.md b/examples/modify/README.md
@@ -1,4 +1,4 @@
-Import hoverpy's main class: HoverPy 
+Demonstrates how to modify requests. This is particularly useful for sending curved balls to your applications, and make sure they deal with them correctly. import hoverpy's main class: HoverPy 
 
 ```python
 from hoverpy import HoverPy

diff --git a/examples/modify/modify.py b/examples/modify/modify.py
@@ -1,3 +1,5 @@
+# Demonstrates how to modify requests. This is particularly useful for sending curved
+# balls to your applications, and make sure they deal with them correctly.
 # import hoverpy's main class: HoverPy
 from hoverpy import HoverPy
 

diff --git a/examples/readthedocs/README.md b/examples/readthedocs/README.md
@@ -1,4 +1,4 @@
-Import hoverpy's main class: HoverPy 
+Slightly more advanced example, where we query readthedocs.io for articles, get these articles. The program can be run in capture or simulate mode, and the functionality is timed. import hoverpy's main class: HoverPy 
 
 ```python
 from hoverpy import HoverPy

diff --git a/examples/readthedocs/readthedocs.py b/examples/readthedocs/readthedocs.py
@@ -1,3 +1,7 @@
+# Slightly more advanced example, where we query readthedocs.io for
+# articles, get these articles. The program can be run in capture or
+# simulate mode, and the functionality is timed.
+
 # import hoverpy's main class: HoverPy
 from hoverpy import HoverPy
 

diff --git a/makefile b/makefile
@@ -62,7 +62,7 @@ docs: .PHONY
 	pandoc --from=markdown --to=rst --output=docs/source/README.rst README.md
 
 	pandoc --from=markdown --to=rst --output=docs/source/basic.rst examples/basic/README.md
-	echo '.. basic\n\nBasic\n********\n\n' | cat - docs/source/basic.rst > temp && mv temp docs/source/basic.rst
+	echo '.. basic\n\nbasic\n********\n\n' | cat - docs/source/basic.rst > temp && mv temp docs/source/basic.rst
 
 	pandoc --from=markdown --to=rst --output=docs/source/readthedocs.rst examples/readthedocs/README.md
 	echo '.. readthedocs\n\nreadthedocs\n********\n\n' | cat - docs/source/readthedocs.rst > temp && mv temp docs/source/readthedocs.rst