12

Sphinxを使用してPythonドキュメントを生成しています。

これは、私たちが使用するコマンドラインです。

sphinx-apidoc -F -o %WORKSPACE%\docs_rst %PACKAGE%

sphinx-build -b html %WORKSPACE%\docs_rst %WORKSPACE%\docs

問題は、パッケージごとに1ページを取得することです。ただし、実際に必要なのは、モジュールごとに1ページです。そうしないと、ページが長くなりすぎます。

これをどのように設定しますか?

4

2 に答える 2

18

私はSphinxにパッチを送信して、あなたが求めていることを正確に実行します。これにより、各モジュールを独自のページに配置するコマンドラインオプションがapidocに追加されます。

パッチはここで見ることができます:https ://bitbucket.org/birkenfeld/sphinx/pull-request/161/added-option-to-apidoc-to-write-each

現在、Sphinxへのマージが保留されています。このコマンドは、次のように機能する別のタグを追加します。

sphinx-apidoc -o [output_dir] [package_dir] --separate

于 2013-09-07T04:38:12.323 に答える
1

autosummary拡張機能とsphinx-autogenスクリプトを使用して(おそらくカスタムテンプレートを使用して)、このようなことを実行できる場合があります。

于 2012-12-07T16:57:13.533 に答える