[ml] Enable strict sphinx check

[diondrapeck]

Description

Please add an informative description that covers that changes made by the pull request and link all relevant issues.

If an SDK is being regenerated based on a new swagger spec, a link to the pull request containing these swagger spec changes has been included above.

All SDK Contribution checklist:

• The pull request does not introduce [breaking changes]
• CHANGELOG is updated for new features, bug fixes or other significant changes.
• I have read the contribution guidelines.

General Guidelines and Best Practices

• Title of the pull request is clear and informative.
• There are a small number of commits, each of which have an informative message. This means that previously merged commits do not appear in the history of the PR. For more information on cleaning up the commits in your PR, see this page.

Testing Guidelines

• Pull request includes test coverage for the included changes.

[diondrapeck]

@kristapratico The only remaining issues we're seeing for azure-ai-ml strict_sphinx compliance is a "duplicate object description" warning. It seems the root of this is having an object exported in multiple module namespaces (i.e. __init__.py files); however, removing an object from an __init__.py file would be a breaking change.

The error messages suggest using :no_index: in the docstring, but I haven't found a way to make that work and I don't see any examples in the azure-sdk-for-python repository of other packages using it. What's your recommendation for dealing with this error?

[kristapratico]

@kristapratico The only remaining issues we're seeing for azure-ai-ml strict_sphinx compliance is a "duplicate object description" warning. It seems the root of this is having an object exported in multiple module namespaces (i.e. __init__.py files); however, removing an object from an __init__.py file would be a breaking change.

The error messages suggest using :no_index: in the docstring, but I haven't found a way to make that work and I don't see any examples in the azure-sdk-for-python repository of other packages using it. What's your recommendation for dealing with this error?

@diondrapeck we should not have the same object exported in multiple module namespaces. We need to figure out for each type whether it should be imported at the parent or child namespace, and then we can use some init-level getattr magic to remove the type from dunder all (see here for an example) and include a deprecation warning to say that the specific type being imported will eventually be removed.

cc @annatisch

[azure-sdk]

API change check

APIView has identified API level changes in this PR and created following API reviews.

azure-ai-ml

[diondrapeck]

@kristapratico The only remaining issues we're seeing for azure-ai-ml strict_sphinx compliance is a "duplicate object description" warning. It seems the root of this is having an object exported in multiple module namespaces (i.e. __init__.py files); however, removing an object from an __init__.py file would be a breaking change.

The error messages suggest using :no_index: in the docstring, but I haven't found a way to make that work and I don't see any examples in the azure-sdk-for-python repository of other packages using it. What's your recommendation for dealing with this error?

@diondrapeck we should not have the same object exported in multiple module namespaces. We need to figure out for each type whether it should be imported at the parent or child namespace, and then we can use some init-level getattr magic to remove the type from dunder all (see here for an example) and include a deprecation warning to say that the specific type being imported will eventually be removed.

cc @annatisch

Done! Thank you.