Pythonのスフィンクスは、階段ピットを使用して記録しました

説明

使用ピップ後スフィンクスをインストールし、チュートリアルに従う以下のように、新しいPYファイルを構築しました

# run.py
def run(name):
    """
    this is how we run
    :param name name of people who runs
    """
    print(name, 'is running')

そして、次のようなディレクトリ構造があることをスフィンクススフィンクス - クイックスタート新しい環境を使用して、新しいディレクトリ：

- doc
    - Makefile
  - build/
  - make.bat
  - source/
- run.py

次のようにこの時点では、ソースディレクトリに、ファイルパスconf.pyを追加しました：

import os
import sys
sys.path.insert(0, os.path.abspath('../..'))

そして、ドキュメントに次のコマンドを実行します。

make html

or

sphinx-build -b html ./doc/source ./doc/build

どちらのコマンドは、テンプレートドキュメントの通常の生産で見つけることができますが、コメントは生成されませんでした。生成されたHTML、ないコードのコメント/ APIドキュメント

以前のバージョンを起動することは矛盾し、その後、再構築されたvirtualenvのか、ではありません。

ミラー、再試行を使用してドッカー、結果は同じエラーであります

また、あなたがindex.rstソースで見つかった変更する必要があり、非公式のコースを見るようにしてください。

例えば、我々のコードファイルがあるrun.py、次のように彼のindex.rstに追加する必要があります（実行モジュール名です）：

API
===
.. automodule:: run
   :members:

再び実行間違っていることがわかった、ではなく、同じヒント：ヒント

Unknown directive type “automodule” or “autoclass”

Googleのそれは、場所の設定を変更する必要性を見つける;位置conf.py、拡張の増加を......、次のとおりです。

extensions = [
        'sphinx.ext.autodoc'
]

もう一度試してみてください、最終的に成功...

たぶん私は、ドキュメントを参照してくださいするのに十分な詳細にされなかったが、それは非常にフレンドリーな感じああではありません