Merge pull request #24 from WadeBarnes/doc-updates

Update generated documents

aries_cloudagent/dispatcher.py

@@ -114,7 +114,7 @@ async def make_message(self, parsed_msg: dict) -> AgentMessage:
  Raises:
  MessageParseError: If the message doesn't specify @type
  MessageParseError: If there is no message class registered to handle
-  the given type
+ the given type
 
  """
 

aries_cloudagent/logging/__init__.py

@@ -53,7 +53,7 @@ def print_banner(
  public_did: Public DID
  banner_length: (Default value = 40) Length of the banner
  border_character: (Default value = ":") Character to use in banner
-  border
+ border
  """
 
  def lr_pad(content: str):

aries_cloudagent/messaging/agent_message.py

@@ -205,7 +205,7 @@ async def verify_signed_field(
  ValueError: If field_name does not exist on this message
  ValueError: If the verification fails
  ValueError: If the verkey of the signature does not match the
-  provided verkey
+ provided verkey
 
  """
  sig = self.get_signature(field_name)
@@ -334,9 +334,9 @@ def extract_decorators(self, data):
 
  Raises:
  ValidationError: If a field signature does not correlate
-  to a field in the message
+ to a field in the message
  ValidationError: If the message defines both a field signature
-  and a value for the same field
+ and a value for the same field
  ValidationError: If there is a missing field signature
 
  """

aries_cloudagent/messaging/protocol_registry.py

@@ -55,7 +55,7 @@ def register_message_types(self, *typesets):
  Add new supported message types.
 
  Args:
- *typesets: Mappings of message types to register
+ typesets: Mappings of message types to register
 
  """
  for typeset in typesets:
@@ -66,7 +66,7 @@ def register_controllers(self, *controller_sets):
  Add new controllers.
 
  Args:
- *controller_sets: Mappings of message families to coroutines
+ controller_sets: Mappings of message families to coroutines
 
  """
  for controlset in controller_sets:

docs/README.md

@@ -1,15 +1,30 @@
 ## How to generate documentation
 
+Ensure the `sphinx_rtd_theme` theme is installed
+
+```
+pip install -U sphinx-rtd-theme
+```
+
 Ensure the sphinx tool is installed and run:
 
+To rebuild the project and settings from scratch:
 ```
-sphinx-apidoc -f -o . ..
+sphinx-apidoc -f -M -F -o . .. '../setup.py'
+```
+
+```
+sphinx-apidoc -f -M -o . .. '../setup.py'
 ```
 
 To auto-generate the module documentation then run:
 
 ```
 make html
 ```
+or
+```
+sphinx-build -b html -a -E -c ./ ./ ./_build
+```
 
 To build the html.

docs/aries_cloudagent.admin.rst

@@ -1,54 +1,50 @@
 aries\_cloudagent.admin package
 ===============================
 
+.. automodule:: aries_cloudagent.admin
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+Subpackages
+-----------
+
+.. toctree::
+
+ aries_cloudagent.admin.tests
+
 Submodules
 ----------
 
 aries\_cloudagent.admin.base\_server module
 -------------------------------------------
 
 .. automodule:: aries_cloudagent.admin.base_server
-  :members:
-  :undoc-members:
-  :show-inheritance:
+ :members:
+ :undoc-members:
+ :show-inheritance:
 
 aries\_cloudagent.admin.error module
 ------------------------------------
 
 .. automodule:: aries_cloudagent.admin.error
-  :members:
-  :undoc-members:
-  :show-inheritance:
+ :members:
+ :undoc-members:
+ :show-inheritance:
 
 aries\_cloudagent.admin.routes module
 -------------------------------------
 
 .. automodule:: aries_cloudagent.admin.routes
-  :members:
-  :undoc-members:
-  :show-inheritance:
+ :members:
+ :undoc-members:
+ :show-inheritance:
 
 aries\_cloudagent.admin.server module
 -------------------------------------
 
 .. automodule:: aries_cloudagent.admin.server
-  :members:
-  :undoc-members:
-  :show-inheritance:
+ :members:
+ :undoc-members:
+ :show-inheritance:
 
-aries\_cloudagent.admin.service module
---------------------------------------
-
-.. automodule:: aries_cloudagent.admin.service
- :members:
- :undoc-members:
- :show-inheritance:
-
-
-Module contents
----------------
-
-.. automodule:: aries_cloudagent.admin
- :members:
- :undoc-members:
- :show-inheritance:

docs/aries_cloudagent.admin.tests.rst

@@ -0,0 +1,19 @@
+aries\_cloudagent.admin.tests package
+=====================================
+
+.. automodule:: aries_cloudagent.admin.tests
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+Submodules
+----------
+
+aries\_cloudagent.admin.tests.test\_admin\_server module
+--------------------------------------------------------
+
+.. automodule:: aries_cloudagent.admin.tests.test_admin_server
+ :members:
+ :undoc-members:
+ :show-inheritance:
+

docs/aries_cloudagent.cache.rst

@@ -1,12 +1,17 @@
 aries\_cloudagent.cache package
 ===============================
 
+.. automodule:: aries_cloudagent.cache
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
 Subpackages
 -----------
 
 .. toctree::
 
-  aries_cloudagent.cache.tests
+ aries_cloudagent.cache.tests
 
 Submodules
 ----------
@@ -15,23 +20,15 @@ aries\_cloudagent.cache.base module
 -----------------------------------
 
 .. automodule:: aries_cloudagent.cache.base
-  :members:
-  :undoc-members:
-  :show-inheritance:
+ :members:
+ :undoc-members:
+ :show-inheritance:
 
 aries\_cloudagent.cache.basic module
 ------------------------------------
 
 .. automodule:: aries_cloudagent.cache.basic
- :members:
- :undoc-members:
- :show-inheritance:
-
+ :members:
+ :undoc-members:
+ :show-inheritance:
 
-Module contents
----------------
-
-.. automodule:: aries_cloudagent.cache
- :members:
- :undoc-members:
- :show-inheritance:

docs/aries_cloudagent.cache.tests.rst

@@ -1,22 +1,19 @@
 aries\_cloudagent.cache.tests package
 =====================================
 
+.. automodule:: aries_cloudagent.cache.tests
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
 Submodules
 ----------
 
 aries\_cloudagent.cache.tests.test\_basic\_cache module
 -------------------------------------------------------
 
 .. automodule:: aries_cloudagent.cache.tests.test_basic_cache
- :members:
- :undoc-members:
- :show-inheritance:
-
+ :members:
+ :undoc-members:
+ :show-inheritance:
 
-Module contents
----------------
-
-.. automodule:: aries_cloudagent.cache.tests
- :members:
- :undoc-members:
- :show-inheritance:

docs/aries_cloudagent.config.rst

@@ -1,12 +1,17 @@
 aries\_cloudagent.config package
 ================================
 
+.. automodule:: aries_cloudagent.config
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
 Subpackages
 -----------
 
 .. toctree::
 
-  aries_cloudagent.config.tests
+ aries_cloudagent.config.tests
 
 Submodules
 ----------
@@ -15,47 +20,39 @@ aries\_cloudagent.config.base module
 ------------------------------------
 
 .. automodule:: aries_cloudagent.config.base
-  :members:
-  :undoc-members:
-  :show-inheritance:
+ :members:
+ :undoc-members:
+ :show-inheritance:
 
 aries\_cloudagent.config.injection\_context module
 --------------------------------------------------
 
 .. automodule:: aries_cloudagent.config.injection_context
-  :members:
-  :undoc-members:
-  :show-inheritance:
+ :members:
+ :undoc-members:
+ :show-inheritance:
 
 aries\_cloudagent.config.injector module
 ----------------------------------------
 
 .. automodule:: aries_cloudagent.config.injector
-  :members:
-  :undoc-members:
-  :show-inheritance:
+ :members:
+ :undoc-members:
+ :show-inheritance:
 
 aries\_cloudagent.config.provider module
 ----------------------------------------
 
 .. automodule:: aries_cloudagent.config.provider
-  :members:
-  :undoc-members:
-  :show-inheritance:
+ :members:
+ :undoc-members:
+ :show-inheritance:
 
 aries\_cloudagent.config.settings module
 ----------------------------------------
 
 .. automodule:: aries_cloudagent.config.settings
- :members:
- :undoc-members:
- :show-inheritance:
-
+ :members:
+ :undoc-members:
+ :show-inheritance:
 
-Module contents
----------------
-
-.. automodule:: aries_cloudagent.config
- :members:
- :undoc-members:
- :show-inheritance: