web-dev-qa-db-ja.com

Sphinx:不明なディレクティブタイプ「toctree」。 Pycharmのエラーですが、index.htmlは機能します

Pycharmで作業しているとき、スフィンクスで作成しているドキュメントのプレビューモードは次のように表示されます。

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

Unknown directive type "toctree".

..toctree::
  :maxdepth: 2

  file1
  file2

Conf.pyファイルに「autodoc」拡張子を含めました。 /build/index.htmlファイルを開くと、正常に動作します。私の質問はこうです:pycharmプレビューモードからこのエラーを削除して、/ build/index.htmlファイルを常に開かなくてもドキュメントをプレビューできるようにするにはどうすればよいですか?

14
Wouter

SphinxはDocutilsライブラリの上に構築されています。 toctreeディレクティブはSphinxで機能しますが、Docutilsでは認識されません。

PyCharmプレビューアはSphinxを使用しません(これは、無料のコミュニティエディションと2019年のProfessionalエディションに当てはまります)。 Docutilsの rst2html.py を使用している可能性があります。

このメーリングリストのスレッドはほぼ同じエラーです: https://web.archive.org/web/20180715103227/https://mail.python.org/pipermail/python-list/2008 -June/493826.html

11
mzjn