Ссылка на внешнюю не-Sphinx документацию с помощью Sphinx - PullRequest
0 голосов
/ 18 апреля 2019

Я пишу документацию для пакета Python, используя Sphinx . Используя intersphinx , можно ссылаться на классы из внешних проектов, например, Numpy . Для этого intersphinx читает файл инвентаризации Numpy, который находится по адресу https://docs.scipy.org/doc/numpy/objects.inv.

Теперь я также хотел бы сослаться на проект с документацией, которая была , а не , созданная с помощью Sphinx. Документация Meep была создана с использованием MkDocs и не содержит файл objects.inv. Таким образом, невозможно использовать intersphinx_mapping.

Можно ли каким-либо образом отобразить документацию Meep? Я бы, например, написал строку документации моей функции как

def f(v):
"""
Parameters
----------
v : meep.Vector3
    Input vector.
"""

В настоящее время Сфинкс жалуется py:class reference target not found: meep.Vector3.

Можно ли определить этот класс для Sphinx и связать его с документацией по https://meep.readthedocs.io/en/latest/Python_User_Interface/#vector3?

...