Ссылка на пакет, сгенерированный через Sphinx-apidoc

Question

При использовании sphinx-apidoc для генерации .rst файлы, выходные данные не содержат меток:

dessn.examples package
======================

.. automodule:: dessn.examples
    :members:
    :undoc-members:
    :show-inheritance:

Subpackages
-----------

.. toctree::

    dessn.examples.discrete
    dessn.examples.simple

Я пытаюсь сделать ссылку на определенную страницу с настроенной домашней страницы, которая не создается с помощью apidoc. Тем не менее, я не могу найти способ вызвать api-doc и заставить его генерировать ярлыки сам, и при этом я не могу придумать какой-либо правильный способ простой ссылки на правую .rst без метки и без простого ввода абсолютного HTML-файла, который я знаю, сгенерирует.

Я могу использовать ::include оператор, и он работает просто отлично, но я не смог найти оператор, который просто сгенерирует гиперссылку на первый файл.

Я что-то упускаю здесь очевидное или мне нужно найти способ сделать ярлыки для вставки api-doc?

ура

Answer 1

Следуя потоку, с которым связан mzjn, лучшее решение на данный момент состоит в том, чтобы сначала понять, что пакет и модуль эквивалентны для этого вопроса, и что вы можете использовать ссылку на модуль python, как подробно описано здесь в sphinx.

Таким образом, ссылка на dessn.examples.simple пакет может быть достигнут, просто вставив код

:py:mod:`dessn.examples.simple`