Sphinx не включает строку документации модуля с использованием директивы automodulePython

Программы на Python
Ответить Пред. темаСлед. тема
Anonymous
 Sphinx не включает строку документации модуля с использованием директивы automodule

Сообщение Anonymous »

У меня есть следующее содержимое в файле __init__.py модуля с именем src:

Код: Выделить всё

"""
.. automodule:: src
:synopsis: Model-View-Controller architecture
"""
Следующее содержимое в index.rst:

Код: Выделить всё

.. Lab documentation master file, created by
sphinx-quickstart on Sat Jun 15 14:26:03 2024.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.

Welcome to Lab's documentation!
===============================

.. toctree::
:maxdepth: 2
:caption: Contents:

business_description
architecture_description

Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`
И следующий контент в Architecture_description.rst:

Код: Выделить всё

Architecture Description
========================

.. automodule:: src
:synopsis:
Все работает нормально, но краткий обзор модуля src не показан в документации.
Что я делаю не так?

Подробнее здесь: https://stackoverflow.com/questions/786 ... -directive
Реклама
Ответить Пред. темаСлед. тема

Быстрый ответ

Изменение регистра текста: 
Смайлики
:) :( :oops: :roll: :wink: :muza: :clever: :sorry: :angel: :read: *x)
Ещё смайлики…
   
К этому ответу прикреплено по крайней мере одно вложение.

Если вы не хотите добавлять вложения, оставьте поля пустыми.

Максимально разрешённый размер вложения: 15 МБ.

  • Похожие темы
    Ответы
    Просмотры
    Последнее сообщение

Вернуться в «Python»