Я пытался использовать sphinx для написания документации для ряда файлов python. Это работает для некоторых из них, но не для всех.
После использования sphinx-apidoc первые файлы создаются для всех файлов python, когда я использую make html, создаются все html-файлы, однако некоторые из них остаются пустыми, когда я их открываю вместо отображения всех комментариев.
Все html-файлы появляются в файле modules.html, но некоторые не отображаются в index.html.
Есть идеи, почему это происходит?
Edit:
Я не уверен, как предоставить более подробную информацию без прямой загрузки всей моей библиотеки. Я запускаю быстрый запуск sphinx в Pycharm, после этого запускаю: sphinx-apidoc -o ./source -f ./ Это создает первый файл для каждого файла .py. После этого я запускаю make html, это создает html-файл для каждого модуля, однако, когда я открываю эти html-файлы, нет документации, несмотря на то, что я комментирую их в том же стиле. И эти файлы также не появляются в файле index.html, но они появляются в файле modules.html.
Когда я запускаю make html, я получаю следующие предупреждения: загрузка инвентаризации intersphinx из docs.python.org/objects.inv ... ПРЕДУПРЕЖДЕНИЕ: не удалось найти ни одну из инвентаризаций со следующими проблемами: ПРЕДУПРЕЖДЕНИЕ: документы инвентаризации intersphinx. python.org/objects.inv '; невозможно извлечь из-за: ('инвентарь межсфинкса% r недоступен из-за% s:% s', 'docs.python.org/objects.inv' ;,, ConnectionError (...)) D: \ SLiM Testing \ source \ modules.rst: ВНИМАНИЕ: документ не включен ни в одно дерево -
В прошлом я также получал это предупреждение, относящееся к файлам .py, которые не отображаются в индексе: попробуйте поместить в документ директиву "module" или "currentmodule" или дать явное имя модуля, но это перестал появляться.
Редактировать 2:
Я не могу понять, как дать больше информации, это может помочь, однако, если я сделаю копию файла python, который работает со sphinx и перезапустит sphinx, это создаст ту же проблему для нового файла, который точно такой же. HTML-файл создан для копирования файла Python, но HTML-файл пуст и не отображается в индексе. Таким образом, проблема должна заключаться в том, как я пытаюсь запустить sphinx, я должен что-то упустить, может кто-то опубликовать шаг за шагом, как правильно запустить sphinx в pycharm?
Еще раз спасибо за вашу помощь
Редактировать 3:
Используя программу по этой ссылке, можете ли вы описать, как создавать документацию с использованием sphinx в Pycharm? Я должен пропустить шаг сейчас, потому что он работал раньше, и теперь он просто создает пустой HTML-файл.
http://www.sphinx -doc.org / ен / стабильный / внутр / example_google.html
Спасибо
Редактировать 4:
Я выяснил проблему, некоторые из новых файлов, в том числе скопированный файл, имели пробелы в названии. Это работает сейчас. Спасибо.