Documentation fixes

docs/api.rst

@@ -27,4 +27,4 @@ Helpers
 
 .. currentmodule:: mygeotab.helpers
 
-.. autofunction:: parse_date_string
+.. autofunction:: parse_date

docs/conf.py

@@ -14,12 +14,13 @@
 
 import sys
 import os
+import datetime
 import sphinx_rtd_theme
 
 # If extensions (or modules to document with autodoc) are in another directory,
 # add these directories to sys.path here. If the directory is relative to the
 # documentation root, use os.path.abspath to make it absolute, like shown here.
-sys.path.insert(0, os.path.abspath('..'))
+sys.path.append(os.path.abspath('..'))
 
 # -- General configuration ------------------------------------------------
 
@@ -50,7 +51,7 @@
 
 # General information about the project.
 project = u'MyGeotab Python SDK'
-copyright = u'2014, Aaron Toth'
+copyright = u'%d, Aaron Toth' % datetime.datetime.utcnow().year
 
 # The version info for the project you're documenting, acts as replacement for
 # |version| and |release|, also used in various other places throughout the

docs/index.rst

@@ -3,49 +3,7 @@
    You can adapt this file completely to your liking, but it should at least
    contain the root `toctree` directive.
 
-Welcome to MyGeotab Python SDK's documentation!
-===============================================
-
-An Apache2 Licensed, unofficial Python client for the MyGeotab API.
-
-Also bundled is the "mygeotab" command line tool, which is a sandboxed console for quickly querying and operating on
-MyGeotab data.
-
-
-Features
---------
-
-- Automatic serializing and deserializing of JSON results
-- Clean, Pythonic API for querying data
-- Cross-platform and compatible with Python 2.7.6 and Python 3.4
-
-
-Usage
------
-
-.. code-block:: python
-
-    >>> import mygeotab
-    >>> api = mygeotab.API(username='hello@example.com', password='mypass', database='DemoDB')
-    >>> api.authenticate()
-    >>> api.call('Get', 'Device', search=dict(name='%Test Dev%'))
-    [{'maxSecondsBetweenLogs': 200.0,
-      'activeTo': '2050-01-01',
-      'minAccidentSpeed': 3.0,
-      'ignoreDownloadsUntil': '1986-01-01',
-      'name': 'Test Device',
-      'idleMinutes': 3.0,
-      ......
-
-
-Installation
-------------
-
-To install the MyGeotab library and command line tool:
-
-.. code-block:: bash
-
-    $ pip install git+https://github.com/aaront/mygeotab
+.. include:: ../README.rst
 
 Command Line Interface
 ----------------------

mygeotab/api.py

@@ -144,6 +144,7 @@ def get(self, type_name, **parameters):
     def search(self, type_name, **parameters):
         """
         Searches for entities using the API. Shortcut for using get() with a search.
+
         :param type_name: The type of entity
         :param parameters: Additional parameters to send.
         :return: The JSON result (decoded into a dict) from the server