Merge pull request #882 from adamtheturtle/automod

Automod

Author: adamtheturtle

dev-requirements.txt

@@ -20,6 +20,7 @@ pytest-cov==2.6.0  # Measure code coverage
 pytest==3.8.2  # Test runners
 PyYAML==3.13
 Sphinx==1.8.1
+sphinx-autodoc-typehints==1.3.0
 sphinxcontrib-spelling==4.2.0
 twine==1.12.1
 versioneer==0.18

docs/source/conf.py

@@ -17,6 +17,7 @@
     'sphinx.ext.autodoc',
     'sphinx.ext.intersphinx',
     'sphinx.ext.napoleon',
+    'sphinx_autodoc_typehints',
     'sphinxcontrib.spelling',
 ]
 
@@ -57,7 +58,6 @@
 autoclass_content = 'init'
 intersphinx_mapping = {
     'python': ('https://docs.python.org/3.7', None),
-    'docker': ('http://docker-py.readthedocs.io/en/stable', None),
 }
 nitpicky = True
 warning_is_error = True
@@ -68,6 +68,9 @@
     ('py:class', 'typing.Optional'),
     ('py:class', '_io.BytesIO'),
     ('py:class', 'docker.types.services.Mount'),
+    # Requests documentation exposes ``requests.Response``, not
+    # ``requests.models.response``.
+    ('py:class', 'requests.models.Response'),
 ]
 
 html_show_copyright = False

docs/source/index.rst

@@ -11,6 +11,12 @@ Installation
 This is tested on Python 3.7+.
 Get in touch with ``adamdangoor@gmail.com`` if you would like to use this with another language.
 
+Reference
+---------
+
+.. automodule:: vws
+   :members:
+
 .. toctree::
    :maxdepth: 3