Merge pull request #52 from petermcd/doc-update

Updated documentation to add autodocs

docs/source/conf.py

@@ -14,7 +14,7 @@
 
 # -- Path setup --------------------------------------------------------------
 
-sys.path.insert(0, os.path.abspath('monzo'))
+sys.path.insert(0, os.path.abspath('../'))
 config = ConfigParser()
 config.read('../../setup.cfg')
 
@@ -35,7 +35,11 @@
 # Add any Sphinx extension module names here, as strings. They can be
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 # ones.
-extensions: List[str] = []
+extensions: List[str] = [
+    'sphinx.ext.autodoc',
+    'sphinx.ext.coverage',
+    'sphinx.ext.doctest',
+]
 
 # Add any paths that contain templates here, relative to this directory.
 templates_path: List[str] = ['_templates']

docs/source/index.rst

@@ -26,6 +26,7 @@ used on a private server.
    :caption: Contents:
 
    tutorials
+   modules
    api_observations
    viewer
    developers

docs/source/modules.rst

@@ -0,0 +1,7 @@
+monzo
+=====
+
+.. toctree::
+   :maxdepth: 4
+
+   monzo

docs/source/monzo.endpoints.rst

@@ -0,0 +1,93 @@
+monzo.endpoints package
+=======================
+
+Submodules
+----------
+
+monzo.endpoints.account module
+------------------------------
+
+.. automodule:: monzo.endpoints.account
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+monzo.endpoints.attachment module
+---------------------------------
+
+.. automodule:: monzo.endpoints.attachment
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+monzo.endpoints.balance module
+------------------------------
+
+.. automodule:: monzo.endpoints.balance
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+monzo.endpoints.feed\_item module
+---------------------------------
+
+.. automodule:: monzo.endpoints.feed_item
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+monzo.endpoints.monzo module
+----------------------------
+
+.. automodule:: monzo.endpoints.monzo
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+monzo.endpoints.pot module
+--------------------------
+
+.. automodule:: monzo.endpoints.pot
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+monzo.endpoints.receipt module
+------------------------------
+
+.. automodule:: monzo.endpoints.receipt
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+monzo.endpoints.transaction module
+----------------------------------
+
+.. automodule:: monzo.endpoints.transaction
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+monzo.endpoints.webhooks module
+-------------------------------
+
+.. automodule:: monzo.endpoints.webhooks
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+monzo.endpoints.whoami module
+-----------------------------
+
+.. automodule:: monzo.endpoints.whoami
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: monzo.endpoints
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/source/monzo.handlers.rst

@@ -0,0 +1,37 @@
+monzo.handlers package
+======================
+
+Submodules
+----------
+
+monzo.handlers.echo module
+--------------------------
+
+.. automodule:: monzo.handlers.echo
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+monzo.handlers.filesystem module
+--------------------------------
+
+.. automodule:: monzo.handlers.filesystem
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+monzo.handlers.storage module
+-----------------------------
+
+.. automodule:: monzo.handlers.storage
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: monzo.handlers
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/source/monzo.rst

@@ -0,0 +1,55 @@
+monzo package
+=============
+
+Subpackages
+-----------
+
+.. toctree::
+   :maxdepth: 4
+
+   monzo.endpoints
+   monzo.handlers
+   monzo.viewer
+
+Submodules
+----------
+
+monzo.authentication module
+---------------------------
+
+.. automodule:: monzo.authentication
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+monzo.exceptions module
+-----------------------
+
+.. automodule:: monzo.exceptions
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+monzo.helpers module
+--------------------
+
+.. automodule:: monzo.helpers
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+monzo.httpio module
+-------------------
+
+.. automodule:: monzo.httpio
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: monzo
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/source/monzo.viewer.html.rst

@@ -0,0 +1,10 @@
+monzo.viewer.html package
+=========================
+
+Module contents
+---------------
+
+.. automodule:: monzo.viewer.html
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/source/monzo.viewer.rst

@@ -0,0 +1,61 @@
+monzo.viewer package
+====================
+
+Subpackages
+-----------
+
+.. toctree::
+   :maxdepth: 4
+
+   monzo.viewer.html
+
+Submodules
+----------
+
+monzo.viewer.controller module
+------------------------------
+
+.. automodule:: monzo.viewer.controller
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+monzo.viewer.filesystem module
+------------------------------
+
+.. automodule:: monzo.viewer.filesystem
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+monzo.viewer.handler module
+---------------------------
+
+.. automodule:: monzo.viewer.handler
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+monzo.viewer.monzo\_data module
+-------------------------------
+
+.. automodule:: monzo.viewer.monzo_data
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+monzo.viewer.server module
+--------------------------
+
+.. automodule:: monzo.viewer.server
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: monzo.viewer
+   :members:
+   :undoc-members:
+   :show-inheritance:

monzo/endpoints/monzo.py

@@ -1,11 +1,9 @@
-"""Base abstract Monzo class."""
-from abc import ABC
-
+"""Base Monzo class."""
 from monzo.authentication import Authentication
 from monzo.exceptions import MonzoAuthenticationError
 
 
-class Monzo(ABC):
+class Monzo(object):
     """
     Abstract base class all endpoints will inherit from.
 

monzo/exceptions.py

@@ -75,7 +75,7 @@ class MonzoGeneralError(MonzoError):
     """
     General error exception.
 
-    Exception to be thrown when a general error occurs that do not fit into other exceptio types
+    Exception to be thrown when a general error occurs that do not fit into other exception types
     """
 
     pass