Skip to content

Unable to generate local doc using Sphinx #16184

Closed
@SuperChenSSS

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:

  1. cd doc/sphinx
  2. sphinx-apidoc -f -e -o ref ../../sdk/cosmos/
  3. make html

Expected behavior
Doc generated with cosmos APIs.

Screenshots
Got errors during make html:
image
image

Also going into the static index.html page, found azure.cosmos API is empty:
image

Additional context
We would like to know:

  1. If the steps are correct to generate API docs?
  2. 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?

Metadata

Assignees

Labels

ClientThis issue points to a problem in the data-plane of the library.CosmosDocs

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions