Sphinxを使用してPythonプロジェクトを文書化する必要があります。しかし、autodoc
を使用できません。
プロジェクトを構成するときに、「拡張autodoc」オプションを選択しますが、ここで
.. autoclass:: Class
エラーが発生します:
ERROR: Unknown directive type "autoclass"
私はPYTHONPATH
を設定しましたが、これで問題ありません。しかし、私はすでにこの問題を抱えています。
私のインデックスファイルは:
.. ATOM documentation master file, created by
sphinx-quickstart on Thu Nov 22 15:24:42 2012.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
Welcome to ATOM's documentation!
================================
Contents:
.. toctree::
:maxdepth: 2
.. automodule:: atom
Indices and tables
==================
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`
問題を解決する方法を教えてくれる人が必要です。
ありがとうございました
同じことが私にも起こりました!これを修正するには、conf.pyの次のような行に移動します。
extensions = ['sphinx.ext.todo', 'sphinx.ext.viewcode']
あなたのものはおそらく違って見えるでしょう。とにかく、'sphinx.ext.autodoc'
をリストに追加します。例えば.
extensions = ['sphinx.ext.todo', 'sphinx.ext.viewcode', 'sphinx.ext.autodoc']
あった場合:
extensions = []
次に、次のように変更します。
extensions = ['sphinx.ext.autodoc']