-
Notifications
You must be signed in to change notification settings - Fork 2.9k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Broken cross-ref links in various docs #7219
Comments
My belief (may well be incorrect) is that |
The tildes control whether the full dotted path is displayed or not. So
The difference between the last two that I am specifically referring to is the "plain text" blue link (which is how the implicit cross refs seem to render everywhere) vs the "outlined" fixed width text link (which is how the explicit |
Sorry, I meant "backticks" when I wrote "tildes". |
Oh, no adding just backticks without the |
Also, AFAIK, single backticks don't actually do much useful, so I have been surprised to see them so much. If you want fixed-width
|
Looks like it is fixed. |
Several package docs at https://azure.github.io/azure-sdk-for-python/ have cross-references to classes that do not render properly, e.g.:
https://azure.github.io/azure-sdk-for-python/ref/azure.eventhub.html#azure.eventhub.consumer.EventHubConsumer.receive
https://azure.github.io/azure-sdk-for-python/ref/azure.servicebus.html#azure.servicebus.servicebus_client.ServiceBusClient.get_queue
https://azure.github.io/azure-sdk-for-python/ref/azure.storage.queue.html#azure.storage.queue.queue_client.QueueClient.create_queue
https://azure.github.io/azure-sdk-for-python/ref/azure.keyvault.secrets.html#azure.keyvault.secrets.client.SecretClient.backup_secret
(This list is not exhaustive, just specific examples in different packages)
I made a small PR to fix this in keyvault: #7215 using explicit directives:
etc. But noted that although things work with this change, the rendered appearance is also different from the "implicitly" rendered cross reference links (I guess these are generated by sphinx-apidoc?) i.e.
VS
The second version is the version with explicit
:class:
(though without a leading tilde to shorten) and is apparently used already in some SDKs. I am not sure how else to fix this problem except to use explicit directives, and FWIW I have only ever used explicit directives in the past.The text was updated successfully, but these errors were encountered: