Skip to content

Broken cross-ref links in various docs #7219

Closed

Description

Several package docs at https://azure.github.io/azure-sdk-for-python/ have cross-references to classes that do not render properly, e.g.:

Screen Shot 2019-09-11 at 2 20 07 PM

(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:

:class:`~foo.Bar`

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.

Screen Shot 2019-09-11 at 2 25 10 PM

VS

Screen Shot 2019-09-11 at 2 24 25 PM

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Assignees

No one assigned

    Labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions