Сфинкс: Неизвестный тип директивы "toctree". ошибка в Pycharm, но index.html работает

При работе в Pycharm режим предварительного просмотра документа, который я создаю в sphinx, показывает:

System Message: ERROR/3 (<stdin>, line 9)

Unknown directive type "toctree".

..toctree::
  :maxdepth: 2

  file1
  file2

Я включил расширение 'autodoc' в мой файл conf.py. Когда я открываю файл /build/index.html, он работает нормально. Таким образом, мой вопрос: как я могу удалить эту ошибку из режима предварительного просмотра pycharm, чтобы я мог предварительно просмотреть свой документ, не открывая файл /build/index.html все время?

Ответы

Ответ 1

Сфинкс построен поверх библиотеки Docutils. Директива toctree работает со Sphinx, но не распознается Docutils.

Предварительный просмотрщик PyCharm не использует Sphinx (это верно для бесплатной версии сообщества и для профессиональных выпусков с 2019 года); скорее всего, он использует rst2html.py из Docutils.

Эта ветка списка рассылки содержит примерно ту же ошибку: https://mail.python.org/pipermail/python-list/2008-June/493826.html.

Ответ 2

Это отредактированная версия вышеуказанного ответа, добавляющая, что это относится и к Pycharm Professional. Это должно быть изменение принятого ответа от mzin выше или комментарий. Однако, поскольку мои изменения отклонены, и у меня нет представителя для комментариев, я добавляю его в качестве ответа, чтобы помочь другим.

Сфинкс построен поверх библиотеки Docutils. Директива toctree работает со Sphinx, но не распознается Docutils.

Предварительный просмотрщик PyCharm не использует Sphinx (по крайней мере, в бесплатном сообществе или профессиональных выпусках с 2019 года); скорее всего, он использует rst2html.py из Docutils.

Эта ветка списка рассылки содержит примерно ту же ошибку: https://mail.python.org/pipermail/python-list/2008-June/493826.html.