Comment référencer une fonction générés par autodoc dans Sphinx?
Je suis en utilisant le Sphinx autodoc
fonctionnalité pour générer la documentation de base sur les docstrings de ma bibliothèque Python.
La syntaxe de la croix-référencement est trouvé ici
Une étiquette doit précéder la section afin de permettre à cette section pour être référencé à partir d'autres domaines de la documentation.
Ce que j'ai est un .tvd (ReStructeredText) fichier pour l'une de mes classes. Il utilise
.. autoclass:: classname
:members:
Pour générer la documentation de la classe.
Ma question est, comment aurais-je de référence auto-généré méthodes de la classe à partir d'un autre .tvd document dans la documentation? Si j'essaie de mettre une étiquette à l'intérieur de la méthode de la docstring, le Sphinx se plaint. Si j'essaie de mettre une étiquette avant de la méthode de la rubrique, le Sphinx ne pas le reconnaître.
Est-il une façon simple de le faire, ou devrai-je écrire explicitement dans mon fichier de classe le nom de la méthode et de précéder qu'avec un label?
Ici est un exemple, une référence au sein de la [documentation PythonDeux faire ce dont j'ai besoin (je suppose qu'il a utilisé l'autodoc fonction, bien que je ne sais pas pour vous)
- Le titre de la demande sur les fonctions, mais le corps et la réponse au sujet des méthodes. Je l'avais espéré, il y aurait une réponse pour le référencement d'un
.. autofunction::
mais hélas ce n'est pas ici.
Vous devez vous connecter pour publier un commentaire.
Vous n'avez pas besoin d'ajouter des étiquettes. Afin de vous référer à un Python de classe, une méthode ou une autre documenté d'un objet, utilisez les balises fournies par le Python domaine.
Ainsi, l'exemple suivant définit une référence croisée à la
mymethod
méthode:Ou encore plus simple (depuis le Python de domaine est la valeur par défaut):
La documentation de
TextWrapper.wrap
que vous lier à la question comprend deux renvois de ce type (cliquez sur "Afficher la Source" pour voir le reste de la majoration).:mod:…
pour les modules.:func:…
pour les fonctions. Une liste complète de la façon de référence croisée Python rôles est ici.