Как настроить Read the Docs для использования аннотации sphinx-autodoc?

Question

Я использую аннотацию sphinx-autodoc, чтобы прочитать аннотации функций в моем коде Python и использовать их для генерации подходящих ожидаемых типов аргументов и возвращаемых типов. Он отлично работает на моей локальной машине, но я должен был pip install sphinx-autodoc-annotation, конечно.

Я пытаюсь создать такую ​​же документацию, используя Read the Docs, но это дает мне ошибку:

Could not import extension sphinx_autodoc_annotation (exception: No module named sphinx_autodoc_annotation) 

Можно ли настроить Читайте Документы для работы с сфинкса-AutoDoc-аннотацией, а если так , как я могу заставить его работать?

Answer 1

Активируйте опцию Установить проект для ознакомления с проектом Docs.

Если этот параметр активирован, прочитайте документы, которые попытаются выполнить setup.py install на вашем пакете (см.: RtD docs). В setup.py вы можете установить пакеты, указанные в вашем requirements file. Например, source code of the Flask-MongoRest project.

Добавить sphinx-autodoc-annotation как единственное требование к вашему requirements.txt файлам.