-
Notifications
You must be signed in to change notification settings - Fork 516
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
Conversation
Signed-off-by: Stephen Curran <[email protected]>
Signed-off-by: Stephen Curran <[email protected]>
Signed-off-by: Stephen Curran <[email protected]>
Codecov Report
@@ Coverage Diff @@
## main #1359 +/- ##
=======================================
Coverage 95.40% 95.40%
=======================================
Files 476 476
Lines 28970 28970
=======================================
Hits 27640 27640
Misses 1330 1330 |
Signed-off-by: Andrew Whitehead <[email protected]>
I think the second group of errors should be fixed now, but I don't know where the first is coming from. |
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:
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
|
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:
__all__
, here are two: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).