xref link broken for msrestazure.azure_active_directory param

[azure]

xref link broken for msrestazure.azure_active_directory param

[lmazuel]

Huuuum, I see. I guess you're right, type of Sphinx is supposed to be a single type, not a complex string.
Tough part if that sphinx accepts it, even if they say they don't :p.

I don't like to point to a module, because it doesn't help that much. I probably should put a aka.ms/pyauth link into the description, and no type. Especially since msrest 0.6.0, there is an additional type possible HTTPPolicy

[mmacy]

Another busted xref link is to the *Configuration instance variable for each client. Lemme know if you'd like a separate issue for this.

azure.mgmt.containerinstance.container_instance_management_client.containerinstancemanagementclien

azure.mgmt.authorization.authorization_management_client.authorizationmanagementclient

Looks like that's coming through from here: AzureServiceClientTemplate.cshtml

[lmazuel]

@mmacy I believe the syntax is correct from Autorest, and it's likely a doc issue for @dendeli-msft. I do my dev on Sphinx for the doc, and it worked at some point (didn't tested recently).

I would expect a link to this:
https://docs.microsoft.com/en-us/python/api/msrestazure/msrestazure.azure_active_directory?view=azure-python

[mmacy]

@lmazuel @dendeli-msft Thanks Laurent. I ran a test at one point, removing the comment and specifying just the type, and it rendered OK:

https://review.docs.microsoft.com/en-us/python/azure-mgmt-containerinstance/azure.mgmt.containerinstance.containerinstancemanagementclient?branch=azure-python

Here's the diff: diff

And the YAML that popped out:

https://github.com/MicrosoftDocs/azure-sdk-reference-test/blob/azure-python/azure-sdk-ref-test-python/docs-ref-autogen/azure-mgmt-containerinstance/azure.mgmt.containerinstance.ContainerInstanceManagementClient.yml#L31

[mmacy]

@lmazuel Ping... 🔔

[lmazuel]

Hi @mmacy
I just created the aka.ms https://aka.ms/pysdkauth

@mmacy , I see here you are able to run test easily, would it be possible for you to test if there is a syntax that the doc processor accept in type for a simple link? Maybe just writing https://aka.ms/pysdkauth, or :link:https://aka.ms/pysdkauth or something else, I don't know out of my head right now.
I can also play a little with Sphinx, but Sphinx supports way more thing, so I won't be sure it will work with the doc.
Thanks!

[mmacy]

@lmazuel Looks like Markdown link format works:

Ref:
https://docs.microsoft.com/en-us/python/api/azure-mgmt-compute/azure.mgmt.compute.v2017_03_30.models.osprofile?view=azure-python#parameters

Src:
https://github.com/Azure/azure-sdk-for-python/blob/master/azure-mgmt-compute/azure/mgmt/compute/v2017_03_30/models/os_profile_py3.py/#L18-L22

EDIT: However, that's in a :param:. I'll do some more investigation.

[lmazuel]

Will be fixed in new autorest with azure-identity link