показать * только * docstring в документации Sphinx

Sphinx имеет функцию automethod которая извлекает документацию из docstring метода и вставляет ее в документацию. Но он не только вставляет docstring, но и подпись метода (имя + аргументы). Как вставить только docstring (исключая подпись метода)?

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

  • Sphinx не находит пакеты Python при использовании autodoc
  • Настроить тему sphinxdoc
  • Использование sphinx для автоматической документирования класса python, модуля
  • Какова связь между докутиками и сфинксом?
  • Минимальный рабочий пример для документации пакета с использованием Sphinx в Python
  • Сделайте один PDF-файл документации Python
  • Условный вывод в документации Sphinx
  • Существуют ли какие-либо реальные альтернативы reStructuredText для документации Python?
  • One Solution collect form web for “показать * только * docstring в документации Sphinx”

    Я думаю, что вы ищете:

     from sphinx.ext import autodoc class DocsonlyMethodDocumenter(autodoc.MethodDocumenter): def format_args(self): return None autodoc.add_documenter(DocsonlyMethodDocumenter) 

    за текущие источники это должно позволить переопределить класс, ответственный за документирование методов (более старые версии add_documenter запрещают такие переопределения, но теперь они явно разрешены). Возвращение format_args None, конечно же, является документированным способом в autodoc чтобы сказать «не надоело подписью».

    Я думаю, что это чистый, продуманный способ выполнения этой задачи и, как таковой, предпочтительнее альтернативных вариантов обезьян. Если вам нужно жить с некоторыми старыми версиями sphinx менее, вам может понадобиться monkeypatch ( autodoc.MethodDocumenter.format_args=lambda _:None – eek!), Хотя я бы рекомендовал обновить sphinx до текущей версии в качестве лучшего подхода, если на всех возможных в вашем конкретном развертывании.

    Python - лучший язык программирования в мире.