Я работаю над документированием фрагмента кода с помощью ReadTheDocs (RTD). Вот репозиторий GitHub, который он создает, а ниже - текущее состояние веб-сайта:
Репо: https://github.com/GluonicPenguin/AutoDQM.
RTD: https://autodqm.readthedocs.io/en/latest/index.html < / а>
Я запустил сборку Sphinx локально и проверил сборку на RTD, и я не получаю никаких предупреждений или ошибок, но _ 1_ неправильно отображает список функций на RTD, т.е. списки функций не отображаются. У меня тоже была проблема с autodqm/compare_hists.py
, и я обнаружил проблема заключалась в том, что у меня была строка import ROOT
вверху (с другими строками импорта), которая, когда импорт вызывается через функцию ROOT (), по какой-то причине это устраняет проблему, и модуль autodqm/compare_hists.py
правильно отображается на веб-сайте.
Я думал, что подобное исправление будет работать с autodqm/dqm.py
, но в этом случае мне нужно определить вверху функции
def lxml():
import lxml.html
return lxml.html
def FuturesSession():
from requests_futures.sessions import FuturesSession
return FuturesSession
и мне нужно удалить класс DQMSession. По крайней мере, я могу думать, что RTD не любит обрабатывать функции импорта в форме import <package>.<subpackage>
.
Я также заранее извиняюсь за все коммиты и расплывчатые / плохие сообщения о коммитах - я делал это исчерпывающе и разрабатывал это локально, а не на GitHub, поэтому мне пришлось продолжать настаивать, чтобы проверить это.
Есть ли причина, по которой текущая установка не работает? Есть ли другие проблемы, которые мне не хватает? Я никогда раньше не использовал Sphinx / RTD, так что я новичок, когда дело доходит до исправления подобных вещей. Причина, по которой я не хочу поддерживать описанное выше быстрое исправление с отдельными функциями импорта, заключается в том, что этот код должен быть эффективным, поскольку он предназначен для сканирования большого количества гистограмм для выполнения сравнения статистики, для которых в таком масштабе важна эффективность.
WARNING: autodoc: failed to import module 'dqm' from module 'autodqm'; the following exception was raised: No module named 'requests_futures'
. Также убедитесь, что вы установили все требования и зависимости для вашего проекта от RTD. - person Steve Piercy   schedule 24.11.2020