Директива autodoc работает локально, но не в readthedocs

Мое репо находится на github здесь: https://github.com/AshleySetter/optoanalysis

И документы находятся в https://github.com/AshleySetter/optoanalysis/tree/master/optoanalysis/docs

ReadTheDocs не дает сбоев, но созданная документация (размещенная здесь: https://optoanalysis.readthedocs.io/en/latest/) не отображает строки документа, которые должны быть созданы командой ..autodoc::.

Однако он отлично работает локально и отображает документацию, когда я открываю файл build / html / index.html.

В ReadTheDocs это выглядит так:

READTHEDOCS documentation

Тогда как локально созданный файл html выглядит так:

локально размещенная документация

Почему это могло быть?


git github python-sphinx read-the-docs
person SomeRandomPhysicist    schedule 08.07.2017    source источник

Ответы (1)


arrow_upward
2
arrow_downward

У вас есть модули, написанные на Cython и скомпилированные для C. Я думаю ReadTheDocs не поддерживает расширения C. Вы должны защитить свой импорт, который будет сгенерирован в ReadTheDocs.

Что-то вроде это:

import os
if 'READTHEDOCS' not in os.environ:
    import cython_generated_ext
person phd    schedule 08.07.2017