Add intersphinx link when using autodoc and "show-inheritance": True

[PhilipMay]

When I have set up intersphinx and use autodoc with "show-inheritance": True then something like this is generated:

Bases: transformers.trainer_callback.TrainerCallback

But transformers.trainer_callback.TrainerCallback is not a link. Just text.

Could you change this so a link is provided?

[tk0miya]

AFAIK, the feature you requested has already been implemented. I think this might be a bug or wrong settings. Could you share a reproducible (minimal) example?

[PhilipMay]

AFAIK, the feature you requested has already been implemented. I think this might be a bug or wrong settings. Could you share a reproducible (minimal) example?

Sure! Thanks...

• config: https://github.com/telekom/HPOflow/blob/main/docs/source/conf.py
• Problem location: https://telekom.github.io/HPOflow/code-doc/optuna_transformers.html#hpoflow.optuna_transformers.OptunaMLflowCallback
• I am using sphinx from pypi -> 4.1.1 at the moment

[PhilipMay]

Here is a screenshot (see link above).

transformers.trainer_callback.TrainerCallback should be a link.

[PhilipMay]

@tk0miya I linked an exmple and added a screenshot.
Can you please check this? I do not think that I misconfigured anything.

This link in the docstring works:

Class based on transformers.TrainerCallback

[PhilipMay]

Code here:

class OptunaMLflowCallback(transformers.TrainerCallback):
    """Integration of Optuna and Transformers.

    Class based on :py:class:`transformers.TrainerCallback`; integrates with OptunaMLflow to send
    the logs to ``MLflow`` and ``Optuna`` during model training.
    """

[tk0miya]

I understand your problem. The upstream document only provides the document for transformers.TrainerCallback instead of transformers.trainer_callback.TrainerCallback. Indeed, it can't be referred.

Since Sphinx-4.0, we provides an option to describe the canonical name of the object. I believe this problem will be solved if the upstream project rebuilds document by latest release.

[miohtama]

Since Sphinx-4.0, we provides an option to describe the canonical name of the object. I believe this problem will be solved if the upstream project rebuilds document by latest release.

I tried to look up documentation on how the canonical name is supposed to behave. Do you need to annotate all the canonical names in the Intersphinx upstream project or are they automatically generated if Sphinx is updated and the upstream projects regenerated its Intersphinx inventory?

[tk0miya]

If the upstream project uses autodoc, it's automatically generated after the upgrade. On the other hand, additional annotations are needed if the upstream project has written their document manually using py:* directive (ex. py:class).
See https://www.sphinx-doc.org/en/master/usage/restructuredtext/domains.html#directive-py-class (:canonical: option).