Сфинкс Autodoc - декоратор и ReadTheDocs - PullRequest
0 голосов
/ 10 мая 2018

У меня небольшие проблемы с автоматически генерируемой документацией Sphinx с помощью autodoc. У меня в основном та же проблема, что и здесь: Автодок Python Sphinx и декорированные элементы

Когда я использовал декоратор для функции, подпись, показанная в документации, была подписью декоратора. Следуя этой теме, я добавил в определение декоратора @decorator декоратор, и это решило проблему.

Теперь я подключил свой проект к ReadTheDoc.org, который работает довольно хорошо, единственное, что проблема с декоратором вернулась независимо от повторного исправления.

Я довольно новичок в Sphinx, поэтому я не уверен, стоит ли это создавать проблему в проекте RTD Github. Чего мне здесь не хватает? Смотрите сломанную подпись здесь

Может ли это быть конфигурацией? Я строю документ с Python3

Кроме того, я определил пустышку @decorator, если модуль недоступен, например:

try:
    from decorator import decorator
except ImportError:
    def decorator(f):
        return f

Спасибо

Ответы [ 2 ]

0 голосов
/ 11 мая 2018

Согласно вашему последнему журналу сборки на RTD , декоратор не был установлен на RTD.

Вы должны либо указать декоратор как зависимость в вашем пакете, либо добавить его в файл требований RTD requirements.txt.

0 голосов
/ 10 мая 2018

Вы можете добавить файл requirements.txt в RTD, и в этом файле вы можете указать ту же среду, что и в вашей локальной сети.

Конечно, включая sphinx, поскольку RTD использует sphinx==1.6.5. Эта версия может отличаться от вашей.

...