Автогенерация документации функций с использованием sphinx в python больше не работает - PullRequest
0 голосов
/ 19 февраля 2019

edit Обратите внимание, что я обнаружил, что проблема вызвана чем-то не так с моей установкой - и я думаю, что это связано с ошибкой при импорте matplotlib.Я оставил свое объяснение проблемы как есть, но я хотел бы знать, почему проблема сломала вещи.

Я имел обыкновение иметь страницу в моей документации, в которой перечислялись все функции и была ссылка наэтот список для документации отдельной функции.Текущая версия без ссылок находится на https://epidemicsonnetworks.readthedocs.io/en/latest/, а код на https://github.com/springer-math/Mathematics-of-Epidemics-on-Networks

Я сделал это, основываясь на ответе на мой предыдущий вопрос: Использование Sphinx для автоматической генерацииотдельный документ для каждой функции

Я только что обнаружил, что в документации больше нет этой ссылки.Несмотря на все мои попытки выяснить это, я не могу найти ничего измененного в моих .rst файлах.Когда я беру более старые версии своего кода из github, который, я уверен, привык работать, у меня все еще остается та же проблема.

Вот то, что я считаю соответствующим битом кода (в файле EoN.rst)

Quick list
^^^^^^^^^^

.. currentmodule:: EoN

.. autosummary::
   :toctree: functions

   fast_SIR
   fast_nonMarkov_SIR
   fast_SIS

(и список довольно длинный).

Папка functions/ существует с соответствующими файлами .rst как functions/EoN.fast_SIR.rst и т. д. Однако, когда я удаляю этоПапка, эти файлы .rst больше не генерируются автоматически sphinx-autobuild . _build/html, хотя пустая папка создается заново.Мои заметки для меня предполагают, что новый файл .rst должен создаваться автоматически.

Что-то изменилось в sphinx без моего ведома?
Или я что-то изменил, не заметив?

edit Я недавно установил Anaconda 4.3.1, что вызвало некоторые проблемы с моей установкой matplotlib (я получаю сообщение об ошибке, что Python не является фреймворком).Может ли это играть роль в том, почему sphinx-autobuild больше не выполняет то, что я ожидаю?

re-edit Я сейчас переделал это на другой машине, и он ведет себя как ожидалось.Так что это не код, это как-то связано с моей установкой, возможно, тот факт, что импорт matplotlib завершился неудачно.Итак, мой обновленный вопрос: может ли сбой импорта вызвать sphinx-autobuild сбой, и если да, то почему?

...