azure-sdk-for-python icon indicating copy to clipboard operation
azure-sdk-for-python copied to clipboard

azure-ai-ml needs docstring updates for sphinx

Open azure-sdk opened this issue 1 year ago • 1 comments
trafficstars

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-ai-ml Sphinx build: Link to build (2024-01-14) How to fix: Run the strict-sphinx tox command at the library package-level and resolve the docstring errors and warnings.

  1. ../azure-ai-ml>pip install "tox<5"

  2. ../azure-ai-ml>tox run -e strict-sphinx -c ../../../eng/tox/tox.ini --root .

  3. Once resolved, set strict_sphinx = true in the package's pyproject.toml file.

See Sphinx and docstring checker for more information.

azure-sdk avatar Dec 17 '23 18:12 azure-sdk

Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc @Azure/azure-ml-sdk @azureml-github.

github-actions[bot] avatar Jan 02 '24 23:01 github-actions[bot]