show * only * docstring dans la documentation Sphinx

Question

Sphinx dispose d'une fonctionnalité appelée automethod qui extrait la documentation de la docstring d'une méthode et l'intègre dans la documentation. Mais il n'introduit pas seulement la docstring, mais aussi la signature de la méthode (name + arguments). Comment puis-je incorporer seulement le docstring (à l'exclusion de la signature de méthode)?

ref: http://sphinx.pocoo.org/ext/autodoc.html

Answer 1

Je pense que ce que vous cherchez est:

from sphinx.ext import autodoc 

class DocsonlyMethodDocumenter(autodoc.MethodDocumenter): 
    def format_args(self): 
    return None 

autodoc.add_documenter(DocsonlyMethodDocumenter) 

par the current sources Cela devrait permettre à quelle classe est primordial responsable de la documentation des méthodes (les anciennes versions de add_documenter interdisaient de telles dérogations, mais maintenant ils sont explicitement autorisés). Ayant format_args retour Aucun, bien sûr, est la façon documentée dans autodoc de dire "ne vous embêtez pas avec la signature". Je pense que c'est la manière propre et architecturée d'effectuer cette tâche, et, en tant que telle, préférable à des alternatives monkeypatching. Si vous avez besoin de vivre avec quelques anciennes versions de sphinx, vous devrez peut-être monkeypatch (autodoc.MethodDocumenter.format_args=lambda _:None - eek! -) bien que je recommanderais de mettre à jour sphinx vers la version actuelle comme une meilleure approche si possible dans votre déploiement spécifique.