Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Updates to the Read The Docs for 0.7.0/1 #1359

Merged
merged 5 commits into from
Aug 22, 2021
Merged

Updates to the Read The Docs for 0.7.0/1 #1359

merged 5 commits into from
Aug 22, 2021

Conversation

swcurran
Copy link
Contributor

Updates various files necessary to generate the Read The Docs files about ACA-Py. Should have been done before the tagging of 0.7.0 -- my miss.

Mostly complete, with two classes of warnings in the generation process remaining as follows:

  1. One instance of this:
WARNING: error while formatting arguments for aries_cloudagent.protocols.issue_credential.v1_0.models.credential_exchange.V10CredentialExchange: unhashable type: 'list'
  1. Nine instances with the same symptom referencing __all__, here are two:
WARNING: __all__ should be a list of strings, not [typing.Callable[[str, dict], dict], <class 'aries_cloudagent.vc.ld_proofs.document_loader.DocumentLoader'>] (in module aries_cloudagent.vc.ld_proofs.document_loader) -- ignoring __all__
WARNING: __all__ should be a list of strings, not [<class 'aries_cloudagent.vc.ld_proofs.crypto.KeyPair.KeyPair'>, <class 'aries_cloudagent.vc.ld_proofs.crypto.WalletKeyPair.WalletKeyPair'>] (in module aries_cloudagent.vc.ld_proofs.crypto) -- ignoring __all__

If anyone knows how to address that, please do.

To reproduce the errors on this branch, follow the instructions in the readme.md file in the \docs folder (install sphinx, run the build command).

@codecov-commenter
Copy link

codecov-commenter commented Aug 19, 2021

Codecov Report

Merging #1359 (110b6d2) into main (feef78a) will not change coverage.
The diff coverage is 100.00%.

@@           Coverage Diff           @@
##             main    #1359   +/-   ##
=======================================
  Coverage   95.40%   95.40%           
=======================================
  Files         476      476           
  Lines       28970    28970           
=======================================
  Hits        27640    27640           
  Misses       1330     1330           

@andrewwhitehead
Copy link
Contributor

I think the second group of errors should be fixed now, but I don't know where the first is coming from.

@swcurran
Copy link
Contributor Author

Thanks for the updates. We're still getting three classes of errors, as follows. Should we just move ahead and merge this PR with these warnings in place? To this point, we've never had docs generation errors, so this would be something new.

During collection of the Docs, we have this error:

WARNING: error while formatting arguments for aries_cloudagent.protocols.issue_credential.v1_0.models.credential_exchange.V10CredentialExchange: unhashable type: 'list'

Then we have 37 instances of this:

aries-cloudagent-python/aries_cloudagent/vc/ld_proofs/ProofSet.py:docstring of aries_cloudagent.vc.ld_proofs.ProofSet:1: WARNING: duplicate object description of aries_cloudagent.vc.ld_proofs.ProofSet, other instance in generated/aries_cloudagent.vc.ld_proofs, use :noindex: for one of them

And the during generation of the HTML files, we have 72 instances of this issue:

/repos/aries-cloudagent-python/aries_cloudagent/vc/ld_proofs/ProofSet.py:docstring of aries_cloudagent.vc.ld_proofs.ProofSet.ProofSet.add:: WARNING: more than one target found for cross-reference 'LinkedDataProof': aries_cloudagent.vc.ld_proofs.LinkedDataProof, aries_cloudagent.vc.ld_proofs.suites.LinkedDataProof.LinkedDataProof

@swcurran swcurran merged commit 55cb279 into openwallet-foundation:main Aug 22, 2021
@swcurran swcurran deleted the rtd-updates branch August 25, 2021 15:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants