2

私は Python モジュールのドキュメント化にSphinxを使用しています。メイン ファイルに含める個々のファイル (モジュール コンポーネントごとに) を配置するマスターdocディレクトリがあります。これはうまく機能します ( Python ライブラリ リファレンスのソースを参照して、私のやり方を正確に確認してください)。*.rstindex.rst

私の問題は、(モジュール全体ではなく) 特定のモジュール コンポーネントのスタンドアロン PDF を作成する必要がある場合です。

完全なモジュール (ライブラリ) のPython ライブラリ リファレンスと同じ構造を持っているとします。次に、cryptoコンポーネントなどのドキュメント用のスタンドアロン PDF を作成します。あなたならどうしますか?

  1. 別のインデックスを作成し ( index_2.rst)、そのファイルのみを含める ( crypto.rst)
  2. 元のファイルから他のファイルをコメントするindex.rst
  3. cryptoスタンドアロンの Sphinx ドキュメントを使用して、まったく新しい doc ディレクトリを作成します

これらのアプローチはどれも単純ではないようです。

アドバイスをお願いします。

4

1 に答える 1

2

まず、 などのテンプレートを作成しますindex_template.rst。次に、1 つのパラメーターを受け取るシェル スクリプトを作成します。このパラメーターは、生成するコンポーネントを指定します。それ以外の場合は、すべてのコンポーネントの index.rst が生成されます。

次に、コンポーネント パラメータをサポートするように Makefile をカスタマイズします。index.rstMakefile は、毎回新しい を生成するシェル スクリプトにこのパラメータを渡します。

これにより、次のようなことができます。

$ make html
$ make html component=crypto

最初のコマンドはすべてのドキュメントを生成し、2 番目のコマンドはcryptoコンポーネントのみを生成します。

于 2011-09-06T17:52:57.807 に答える