python - Windows でスフィンクス ドキュメント ジェネレーターを使用するには?

Question

sphinxドキュメントジェネレーターを使ってサイトを作りたいです。しかし、私のマシンはWindowsです。Windows 用の十分なリソースが見つかりません。Windows にスフィンクスを実装する方法を誰かが提案してくれれば、大きな助けになるでしょう。

ありがとう。

Answer 1

Sphinx は Windows で問題なく動作します。開始するには、クイックスタートチュートリアルに移動し、指示に従います。追加したいことの 1 つは、ビルド フォルダーとソース フォルダーを分離するかどうかを尋ねる質問に対して、必ず "y" と答えるようにすることです。これにより、後で物事がより簡単になります。

apidoc を使用する場合 (使用していると思います)、Python インストールの Scripts フォルダーにあるコマンドライン ツールを使用できます。または、独自のスクリプトを作成することもできます。以下は、いくつかのターゲット モジュールの .rst ファイルを取得するために私が書いたものです。

files = [u'C:\\Work\\Scripts\\Grapher\\both_pyplot.py',
         u'C:\\Work\\Scripts\\Grapher\\colors_pyplot.py',
         u'C:\\Work\\Scripts\\Grapher\\dataEditor.pyw',
         u'C:\\Work\\Scripts\\Grapher\\grapher.pyw']

for d in ('pyfiles', 'rst_temp'):
    try:
        shutil.rmtree(d)
    except WindowsError:
        pass
    os.mkdir(d)

#copy, rename .pyw files to .py so sphinx will pick them up
for fn in files:
    fn2 = fn
    if fn.lower().endswith('.pyw'):
        fn2 = fn[:-1]
    shutil.copy2(fn, os.path.join('pyfiles', os.path.basename(fn2)))

#now send to apidoc
lst = [fn, '-o', 'rst_temp', 'pyfiles']  
from sphinx.apidoc import main
main(lst)


msg = ('Now copy the rst files you want documentation for from the '
      '"rst_temp" dir to the the "source" dir, edit the index.html file '
      'in the "source" dir, and run builder.py')
print msg 

apidoc 拡張子は .pyw ファイルを認識しないため、このスクリプトはターゲット モジュールを一時的な場所にコピーし、apidoc が使用できるように .py 拡張子を付けて名前を変更します。

プロジェクトをビルドするには、プロジェクト フォルダー (クイックスタートの実行時に作成される) で make.bat ファイルを実行するか、独自のスクリプトを記述します。サンプル (builder.py) は次のとおりです。

import sys, os
fn = __file__

sys.path.append(os.path.normpath('C:\\Work\\Scripts\\Grapher'))

lst = [fn, '-b', 'html', 'source', 'build']

from sphinx import main
main(lst)