You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
A number of documentation warnings are generated in the ACA-Py read-the-docs documentation when the ACA-Py module "vc" is not mocked out. Sometimes such warnings are an indication of a problem in the code, so I think this is worth a review. To replicate the problem:
Follow the steps in the ReadMe in the docs folder of ACA-Py to locally generate the Sphinx documentation. The second of the three steps can be ignored (although it won't hurt) -- just do the sphinx install (if needed) and then run the sphinx build... command. The result is the docs should generate with one warning that you can ignore.
Edit the conf.py file in the /docs folder and remove from the list of autodoc_mock_imports the aries_cloudagent.vc entry - the last one.
Regenerate and you should see many warnings.
Investigate, resolve if possible, or at least confirm that the issues are not important.
The impact of the issue is that the documentation for that module (vc) is not included in the docs. And as noted above, it might indicate a larger issue.
Worst case, please document what you find and note why it is not an issue. Best case -- submit a PR to address the issue.
For bonus points -- if you can address the one unrelated warning (the one there even with vc mock'd), that would be great.
Thanks!
The text was updated successfully, but these errors were encountered:
A number of documentation warnings are generated in the ACA-Py read-the-docs documentation when the ACA-Py module "vc" is not mocked out. Sometimes such warnings are an indication of a problem in the code, so I think this is worth a review. To replicate the problem:
sphinx build...
command. The result is the docs should generate with one warning that you can ignore.conf.py
file in the /docs folder and remove from the list ofautodoc_mock_imports
thearies_cloudagent.vc
entry - the last one.The impact of the issue is that the documentation for that module (
vc
) is not included in the docs. And as noted above, it might indicate a larger issue.Worst case, please document what you find and note why it is not an issue. Best case -- submit a PR to address the issue.
For bonus points -- if you can address the one unrelated warning (the one there even with
vc
mock'd), that would be great.Thanks!
The text was updated successfully, but these errors were encountered: