More docs updates

qacafe · Jan 9, 2017 · 0ee991c · 0ee991c
1 parent 97145c9
commit 0ee991c
Show file tree

Hide file tree

Showing 3 changed files with 142 additions and 115 deletions.
diff --git a/docs/index.rst b/docs/index.rst
@@ -10,118 +10,5 @@ Welcome to cdrouter.py's documentation!
    :maxdepth: 2
    :caption: Contents:
 
-cdrouter
---------
-
-.. automodule:: cdrouter
-   :members:
-
-cdrouter.Service
-~~~~~~~~~~~~~~~~
-
-.. autoclass:: cdrouter.Service
-   :members:
-
-cdrouter.ConfigsService
-~~~~~~~~~~~~~~~~~~~~~~~
-
-.. autoclass:: cdrouter.ConfigsService
-   :members:
-
-cdrouter.DevicesService
-~~~~~~~~~~~~~~~~~~~~~~~
-
-.. autoclass:: cdrouter.DevicesService
-   :members:
-
-cdrouter.JobsService
-~~~~~~~~~~~~~~~~~~~~
-
-.. autoclass:: cdrouter.JobsService
-   :members:
-
-cdrouter.PackagesService
-~~~~~~~~~~~~~~~~~~~~~~~~
-
-.. autoclass:: cdrouter.PackagesService
-   :members:
-
-cdrouter.ResultsService
-~~~~~~~~~~~~~~~~~~~~~~~
-
-.. autoclass:: cdrouter.ResultsService
-   :members:
-
-cdrouter.TestResultsService
-~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-.. autoclass:: cdrouter.TestResultsService
-   :members:
-
-cdrouter.AnnotationsService
-~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-.. autoclass:: cdrouter.AnnotationsService
-   :members:
-
-cdrouter.CapturesService
-~~~~~~~~~~~~~~~~~~~~~~~~
-
-.. autoclass:: cdrouter.CapturesService
-   :members:
-
-cdrouter.HighlightsService
-~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-.. autoclass:: cdrouter.HighlightsService
-   :members:
-
-cdrouter.ImportsService
-~~~~~~~~~~~~~~~~~~~~~~~
-
-.. autoclass:: cdrouter.ImportsService
-   :members:
-
-cdrouter.ExportsService
-~~~~~~~~~~~~~~~~~~~~~~~
-
-.. autoclass:: cdrouter.ExportsService
-   :members:
-
-cdrouter.HistoryService
-~~~~~~~~~~~~~~~~~~~~~~~
-
-.. autoclass:: cdrouter.HistoryService
-   :members:
-
-cdrouter.SystemService
-~~~~~~~~~~~~~~~~~~~~~~
-
-.. autoclass:: cdrouter.SystemService
-   :members:
-
-cdrouter.TagsService
-~~~~~~~~~~~~~~~~~~~~
-
-.. autoclass:: cdrouter.TagsService
-   :members:
-
-cdrouter.TestsuitesService
-~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-.. autoclass:: cdrouter.TestsuitesService
-   :members:
-
-cdrouter.UsersService
-~~~~~~~~~~~~~~~~~~~~~
-
-.. autoclass:: cdrouter.UsersService
-   :members:
-
-
-Indices and tables
-==================
-
-* :ref:`genindex`
-* :ref:`modindex`
-* :ref:`search`
+   introduction
+   reference
diff --git a/docs/introduction.rst b/docs/introduction.rst
@@ -0,0 +1,30 @@
+Introduction
+============
+
+cdrouter is a simple wrapper for the CDRouter Web
+API. https://support.qacafe.com/cdrouter-web-api/
+
+For more information on CDRouter, please visit http://www.qacafe.com/.
+
+Download & Install
+------------------
+
+cdrouter is available on PyPI.
+
+.. code-block:: bash
+
+    $ pip install cdrouter
+
+
+Usage
+-----
+
+.. code-block:: python
+
+    import cdrouter
+
+    service = cdrouter.Service('http://localhost:8015', token='deadbeef')
+    packages = cdrouter.PackagesService(service)
+
+    print packages.list(filter=['name~'], page=2).json()
+    print packages.get(164).json()
diff --git a/docs/reference.rst b/docs/reference.rst
@@ -0,0 +1,110 @@
+Reference
+=========
+
+cdrouter
+~~~~~~~~
+
+.. automodule:: cdrouter
+   :members:
+
+cdrouter.Service
+~~~~~~~~~~~~~~~~
+
+.. autoclass:: cdrouter.Service
+   :members:
+
+cdrouter.ConfigsService
+~~~~~~~~~~~~~~~~~~~~~~~
+
+.. autoclass:: cdrouter.ConfigsService
+   :members:
+
+cdrouter.DevicesService
+~~~~~~~~~~~~~~~~~~~~~~~
+
+.. autoclass:: cdrouter.DevicesService
+   :members:
+
+cdrouter.JobsService
+~~~~~~~~~~~~~~~~~~~~
+
+.. autoclass:: cdrouter.JobsService
+   :members:
+
+cdrouter.PackagesService
+~~~~~~~~~~~~~~~~~~~~~~~~
+
+.. autoclass:: cdrouter.PackagesService
+   :members:
+
+cdrouter.ResultsService
+~~~~~~~~~~~~~~~~~~~~~~~
+
+.. autoclass:: cdrouter.ResultsService
+   :members:
+
+cdrouter.TestResultsService
+~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+.. autoclass:: cdrouter.TestResultsService
+   :members:
+
+cdrouter.AnnotationsService
+~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+.. autoclass:: cdrouter.AnnotationsService
+   :members:
+
+cdrouter.CapturesService
+~~~~~~~~~~~~~~~~~~~~~~~~
+
+.. autoclass:: cdrouter.CapturesService
+   :members:
+
+cdrouter.HighlightsService
+~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+.. autoclass:: cdrouter.HighlightsService
+   :members:
+
+cdrouter.ImportsService
+~~~~~~~~~~~~~~~~~~~~~~~
+
+.. autoclass:: cdrouter.ImportsService
+   :members:
+
+cdrouter.ExportsService
+~~~~~~~~~~~~~~~~~~~~~~~
+
+.. autoclass:: cdrouter.ExportsService
+   :members:
+
+cdrouter.HistoryService
+~~~~~~~~~~~~~~~~~~~~~~~
+
+.. autoclass:: cdrouter.HistoryService
+   :members:
+
+cdrouter.SystemService
+~~~~~~~~~~~~~~~~~~~~~~
+
+.. autoclass:: cdrouter.SystemService
+   :members:
+
+cdrouter.TagsService
+~~~~~~~~~~~~~~~~~~~~
+
+.. autoclass:: cdrouter.TagsService
+   :members:
+
+cdrouter.TestsuitesService
+~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+.. autoclass:: cdrouter.TestsuitesService
+   :members:
+
+cdrouter.UsersService
+~~~~~~~~~~~~~~~~~~~~~
+
+.. autoclass:: cdrouter.UsersService
+   :members: