Updates to eliminate warnings on RTD doc generation

Signed-off-by: Stephen Curran <[email protected]>

docs/README.md

@@ -21,15 +21,16 @@ updated, as noted below.
 To test generate and view the RTD documentation locally, you must install [Sphinx](https://www.sphinx-doc.org/en/master/) and the
 [Sphinx RTD theme](https://pypi.org/project/sphinx-rtd-theme/). Both can be installed from PyPi using pip. For example:
 
-```
+``` bash
 pip install -U sphinx
 pip install -U sphinx-rtd-theme
 ```
 
 ### Generate Module Files
 
 To rebuild the project and settings from scratch (you'll need to move the generated index file up a level):
-```
+
+``` bash
 rm -rf generated
 sphinx-apidoc -f -M -o  ./generated ../aries_cloudagent/ $(find ../aries_cloudagent/ -name '*tests*')
 ```
@@ -42,12 +43,12 @@ Check the  `git status` in your repo to see if the generator updates, adds or re
 
 To auto-generate the module documentation locally run:
 
-```
+``` bash
 sphinx-build -b html -a -E -c ./ ./ ./_build
 ```
 
 Once generated, go into the `_build` folder and open `index.html` in a browser. Note that the `_build` is
-`.gitignore'd` and so will not be part of a git push.
+`.gitignore`'d and so will not be part of a git push.
 
 ### Look for Errors
 

docs/conf.py

@@ -43,6 +43,7 @@
     "dateutil",
     "jsonpath_ng",
     "unflatten",
+    "aries_cloudagent.vc",
 ]
 
 #    "aries_cloudagent.tests.test_conductor",

docs/generated/aries_cloudagent.vc.ld_proofs.crypto.rst

@@ -9,18 +9,18 @@ aries\_cloudagent.vc.ld\_proofs.crypto package
 Submodules
 ----------
 
-aries\_cloudagent.vc.ld\_proofs.crypto.KeyPair module
------------------------------------------------------
+aries\_cloudagent.vc.ld\_proofs.crypto.key\_pair module
+-------------------------------------------------------
 
-.. automodule:: aries_cloudagent.vc.ld_proofs.crypto.KeyPair
+.. automodule:: aries_cloudagent.vc.ld_proofs.crypto.key_pair
    :members:
    :undoc-members:
    :show-inheritance:
 
-aries\_cloudagent.vc.ld\_proofs.crypto.WalletKeyPair module
------------------------------------------------------------
+aries\_cloudagent.vc.ld\_proofs.crypto.wallet\_key\_pair module
+---------------------------------------------------------------
 
-.. automodule:: aries_cloudagent.vc.ld_proofs.crypto.WalletKeyPair
+.. automodule:: aries_cloudagent.vc.ld_proofs.crypto.wallet_key_pair
    :members:
    :undoc-members:
    :show-inheritance:

docs/generated/aries_cloudagent.vc.ld_proofs.purposes.rst

@@ -9,42 +9,42 @@ aries\_cloudagent.vc.ld\_proofs.purposes package
 Submodules
 ----------
 
-aries\_cloudagent.vc.ld\_proofs.purposes.AssertionProofPurpose module
----------------------------------------------------------------------
+aries\_cloudagent.vc.ld\_proofs.purposes.assertion\_proof\_purpose module
+-------------------------------------------------------------------------
 
-.. automodule:: aries_cloudagent.vc.ld_proofs.purposes.AssertionProofPurpose
+.. automodule:: aries_cloudagent.vc.ld_proofs.purposes.assertion_proof_purpose
    :members:
    :undoc-members:
    :show-inheritance:
 
-aries\_cloudagent.vc.ld\_proofs.purposes.AuthenticationProofPurpose module
---------------------------------------------------------------------------
+aries\_cloudagent.vc.ld\_proofs.purposes.authentication\_proof\_purpose module
+------------------------------------------------------------------------------
 
-.. automodule:: aries_cloudagent.vc.ld_proofs.purposes.AuthenticationProofPurpose
+.. automodule:: aries_cloudagent.vc.ld_proofs.purposes.authentication_proof_purpose
    :members:
    :undoc-members:
    :show-inheritance:
 
-aries\_cloudagent.vc.ld\_proofs.purposes.ControllerProofPurpose module
-----------------------------------------------------------------------
+aries\_cloudagent.vc.ld\_proofs.purposes.controller\_proof\_purpose module
+--------------------------------------------------------------------------
 
-.. automodule:: aries_cloudagent.vc.ld_proofs.purposes.ControllerProofPurpose
+.. automodule:: aries_cloudagent.vc.ld_proofs.purposes.controller_proof_purpose
    :members:
    :undoc-members:
    :show-inheritance:
 
-aries\_cloudagent.vc.ld\_proofs.purposes.CredentialIssuancePurpose module
--------------------------------------------------------------------------
+aries\_cloudagent.vc.ld\_proofs.purposes.credential\_issuance\_purpose module
+-----------------------------------------------------------------------------
 
-.. automodule:: aries_cloudagent.vc.ld_proofs.purposes.CredentialIssuancePurpose
+.. automodule:: aries_cloudagent.vc.ld_proofs.purposes.credential_issuance_purpose
    :members:
    :undoc-members:
    :show-inheritance:
 
-aries\_cloudagent.vc.ld\_proofs.purposes.ProofPurpose module
-------------------------------------------------------------
+aries\_cloudagent.vc.ld\_proofs.purposes.proof\_purpose module
+--------------------------------------------------------------
 
-.. automodule:: aries_cloudagent.vc.ld_proofs.purposes.ProofPurpose
+.. automodule:: aries_cloudagent.vc.ld_proofs.purposes.proof_purpose
    :members:
    :undoc-members:
    :show-inheritance:

docs/generated/aries_cloudagent.vc.ld_proofs.rst

@@ -19,14 +19,6 @@ Subpackages
 Submodules
 ----------
 
-aries\_cloudagent.vc.ld\_proofs.ProofSet module
------------------------------------------------
-
-.. automodule:: aries_cloudagent.vc.ld_proofs.ProofSet
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
 aries\_cloudagent.vc.ld\_proofs.check module
 --------------------------------------------
 
@@ -67,6 +59,14 @@ aries\_cloudagent.vc.ld\_proofs.ld\_proofs module
    :undoc-members:
    :show-inheritance:
 
+aries\_cloudagent.vc.ld\_proofs.proof\_set module
+-------------------------------------------------
+
+.. automodule:: aries_cloudagent.vc.ld_proofs.proof_set
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
 aries\_cloudagent.vc.ld\_proofs.validation\_result module
 ---------------------------------------------------------
 

docs/generated/aries_cloudagent.vc.ld_proofs.suites.rst

@@ -9,58 +9,58 @@ aries\_cloudagent.vc.ld\_proofs.suites package
 Submodules
 ----------
 
-aries\_cloudagent.vc.ld\_proofs.suites.BbsBlsSignature2020 module
------------------------------------------------------------------
+aries\_cloudagent.vc.ld\_proofs.suites.bbs\_bls\_signature\_2020 module
+-----------------------------------------------------------------------
 
-.. automodule:: aries_cloudagent.vc.ld_proofs.suites.BbsBlsSignature2020
+.. automodule:: aries_cloudagent.vc.ld_proofs.suites.bbs_bls_signature_2020
    :members:
    :undoc-members:
    :show-inheritance:
 
-aries\_cloudagent.vc.ld\_proofs.suites.BbsBlsSignature2020Base module
----------------------------------------------------------------------
+aries\_cloudagent.vc.ld\_proofs.suites.bbs\_bls\_signature\_2020\_base module
+-----------------------------------------------------------------------------
 
-.. automodule:: aries_cloudagent.vc.ld_proofs.suites.BbsBlsSignature2020Base
+.. automodule:: aries_cloudagent.vc.ld_proofs.suites.bbs_bls_signature_2020_base
    :members:
    :undoc-members:
    :show-inheritance:
 
-aries\_cloudagent.vc.ld\_proofs.suites.BbsBlsSignatureProof2020 module
-----------------------------------------------------------------------
+aries\_cloudagent.vc.ld\_proofs.suites.bbs\_bls\_signature\_proof\_2020 module
+------------------------------------------------------------------------------
 
-.. automodule:: aries_cloudagent.vc.ld_proofs.suites.BbsBlsSignatureProof2020
+.. automodule:: aries_cloudagent.vc.ld_proofs.suites.bbs_bls_signature_proof_2020
    :members:
    :undoc-members:
    :show-inheritance:
 
-aries\_cloudagent.vc.ld\_proofs.suites.Ed25519Signature2018 module
-------------------------------------------------------------------
+aries\_cloudagent.vc.ld\_proofs.suites.ed25519\_signature\_2018 module
+----------------------------------------------------------------------
 
-.. automodule:: aries_cloudagent.vc.ld_proofs.suites.Ed25519Signature2018
+.. automodule:: aries_cloudagent.vc.ld_proofs.suites.ed25519_signature_2018
    :members:
    :undoc-members:
    :show-inheritance:
 
-aries\_cloudagent.vc.ld\_proofs.suites.JwsLinkedDataSignature module
---------------------------------------------------------------------
+aries\_cloudagent.vc.ld\_proofs.suites.jws\_linked\_data\_signature module
+--------------------------------------------------------------------------
 
-.. automodule:: aries_cloudagent.vc.ld_proofs.suites.JwsLinkedDataSignature
+.. automodule:: aries_cloudagent.vc.ld_proofs.suites.jws_linked_data_signature
    :members:
    :undoc-members:
    :show-inheritance:
 
-aries\_cloudagent.vc.ld\_proofs.suites.LinkedDataProof module
--------------------------------------------------------------
+aries\_cloudagent.vc.ld\_proofs.suites.linked\_data\_proof module
+-----------------------------------------------------------------
 
-.. automodule:: aries_cloudagent.vc.ld_proofs.suites.LinkedDataProof
+.. automodule:: aries_cloudagent.vc.ld_proofs.suites.linked_data_proof
    :members:
    :undoc-members:
    :show-inheritance:
 
-aries\_cloudagent.vc.ld\_proofs.suites.LinkedDataSignature module
------------------------------------------------------------------
+aries\_cloudagent.vc.ld\_proofs.suites.linked\_data\_signature module
+---------------------------------------------------------------------
 
-.. automodule:: aries_cloudagent.vc.ld_proofs.suites.LinkedDataSignature
+.. automodule:: aries_cloudagent.vc.ld_proofs.suites.linked_data_signature
    :members:
    :undoc-members:
    :show-inheritance: