Added API documentation.

jfjlaros · Jan 16, 2021 · bdc60eb · bdc60eb
1 parent 5c732f6
commit bdc60eb
Show file tree

Hide file tree

Showing 6 changed files with 42 additions and 0 deletions.
diff --git a/docs/api.rst b/docs/api.rst
@@ -0,0 +1,11 @@
+API documentation
+=================
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:
+   :glob:
+
+   api/simple_rpc
+   api/protocol
+   api/extras
diff --git a/docs/api/extras.rst b/docs/api/extras.rst
@@ -0,0 +1,5 @@
+Extras
+======
+
+.. automodule:: simple_rpc.extras
+   :members:
diff --git a/docs/api/protocol.rst b/docs/api/protocol.rst
@@ -0,0 +1,5 @@
+Protocol
+========
+
+.. automodule:: simple_rpc.protocol
+   :members:
diff --git a/docs/api/simple_rpc.rst b/docs/api/simple_rpc.rst
@@ -0,0 +1,5 @@
+SimpleRPC
+=========
+
+.. automodule:: simple_rpc.simple_rpc
+   :members:
diff --git a/docs/conf.py b/docs/conf.py
@@ -0,0 +1,15 @@
+from subprocess import call
+
+call('pip install six ..', shell=True)
+
+from ordered_map import _get_metadata
+
+
+author = _get_metadata('Author')
+copyright = _get_metadata('Author')
+project = _get_metadata('Name')
+release = _get_metadata('Version')
+
+autoclass_content = 'both'
+extensions = ['sphinx.ext.autodoc']
+master_doc = 'index'
diff --git a/docs/index.rst b/docs/index.rst
@@ -8,4 +8,5 @@
    install
    usage
    library
+   api
    credits