Closed
Description
- Package Name: cosmos, Sphinx
- Package Version: V4
- Operating System: Ubuntu
- Python Version: 3.8.5
Describe the bug
I can see doc folder in the repository. I tried to use Sphinx-build tool to generate the doc containing cosmos APIs, but got errors and see the content is blank for cosmos APIs.
To Reproduce
That's the steps I followed:
- cd doc/sphinx
- sphinx-apidoc -f -e -o ref ../../sdk/cosmos/
- make html
Expected behavior
Doc generated with cosmos APIs.
Screenshots
Got errors during make html:
Also going into the static index.html page, found azure.cosmos API is empty:
Additional context
We would like to know:
- If the steps are correct to generate API docs?
- By reading errors, it seems some contents are missing from the ref folder. How should I avoid these and see actual content in the generated html page?