web-dev-qa-db-fra.com

Sphinx: type de directive inconnu "toctree". erreur dans Pycharm, mais index.html fonctionne

Lorsque vous travaillez dans Pycharm, le mode d'aperçu du document que je crée dans sphinx montre:

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

Unknown directive type "toctree".

..toctree::
  :maxdepth: 2

  file1
  file2

J'ai inclus l'extension 'autodoc' dans mon fichier conf.py. Lorsque j'ouvre le fichier /build/index.html, cela fonctionne bien cependant. Ma question est donc la suivante: comment supprimer cette erreur du mode d'aperçu pycharm, afin de pouvoir prévisualiser mon document sans avoir à ouvrir le fichier /build/index.html tout le temps?

pycharmpython-sphinxpreviewautodoc
11
Wouter

Sphinx est construit au-dessus de la bibliothèque Docutils. La directive toctree fonctionne avec Sphinx, mais elle n'est pas reconnue par Docutils.

L'aperçu PyCharm n'utilise pas Sphinx (du moins pas dans l'édition communautaire gratuite); il utilise probablement rst2html.py de Docutils.

Ce fil de liste de diffusion est à peu près la même erreur: https://mail.python.org/pipermail/python-list/2008-June/493826.html .

4
mzjn