-
Notifications
You must be signed in to change notification settings - Fork 3.1k
Description
ACTION NEEDED: All sphinx errors and warnings must be fixed by 2024-04-15. The build will begin to fail for this library if errors are not fixed.
This issue indicates that your library reference documentation is rendering with errors. To avoid customer issues, please ensure you take care of these errors and warnings ASAP.
Library name: azure-monitor-query
Sphinx build: Link to build (2023-12-31)
How to fix: Run the strict-sphinx
tox command at the library package-level and resolve the docstring errors and warnings.
-
../azure-monitor-query>pip install "tox<5"
-
../azure-monitor-query>tox run -e strict-sphinx -c ../../../eng/tox/tox.ini --root .
-
Once resolved, set
strict_sphinx = true
in the package's pyproject.toml file.
See Sphinx and docstring checker for more information.