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

Oddity in the "vc" module when generating ReadTheDocs docs -- a bug? #1506

Closed
swcurran opened this issue Nov 19, 2021 · 1 comment · Fixed by #1509
Closed

Oddity in the "vc" module when generating ReadTheDocs docs -- a bug? #1506

swcurran opened this issue Nov 19, 2021 · 1 comment · Fixed by #1509
Assignees

Comments

@swcurran
Copy link
Contributor

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:

  1. 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.
  2. 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.
  3. Regenerate and you should see many warnings.
  4. 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!

@swcurran
Copy link
Contributor Author

A little one for you @shaangill025 before a larger one that is coming.

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 a pull request may close this issue.

2 participants