Lien vers la méthode de classe d'un autre module dans la documentation Python

Question

Je veux ajouter un lien d'une méthode d'un module (disons module_2.py) dans une autre méthode d'un autre module (disons module_1.py). Je veux que le lien fonctionne dans Sphinx.

Supposons :

module_1.py

class ABC:
   def foo(self):
      """
     Voir la docstring de bar() de module_2.py : 
      """
      print("foo")

module_2.py

class XYZ:
    def bar(self):
    """
     Cette fonction affiche bonjour.
    """
    print("bonjour")

Answer 1

Vous pouvez écrire:

class ABC:
  def foo(self):
    """
    Voir la docstring de :py:meth:`bar() ` dans :py:mod:`module_2`.
    """
    print("foo")

La balise affichée utilise un rôle pour lier à un élément documenté. Si Python est le domaine par défaut pour votre documentation, alors :py peut être omis. Le rôle meth lie à un nom de méthode. Un nom pointé peut être utilisé. De même, mod lie à un nom de module. Le contenu d'un rôle est écrit entre ``. Le contenu (nom de lien logique) peut avoir un affichage visuel différent. Par conséquent, le nom de lien logique est écrit dans <>. Exemple: :role:`texte `.

Plus d'informations: http://www.sphinx-doc.org/en/stable/domains.html#role-py:meth