問題タブ [sphinx-apidoc]

Sphinxを使用してコードベースの基本的なドキュメントを自動生成しようとしています。ただし、ファイルを再帰的にスキャンするようにSphinxに指示するのが困難です。

次のようなフォルダ構造を持つPythonコードベースがあります。

でsphinx-quickstartを実行した<workspace>ので、構造は次のようになります。

クイックスタートチュートリアルを読みましたが、まだドキュメントを理解しようとしていますが、その言い回しでは、コードベース内のすべてのモジュール/クラス/関数のドキュメントファイルを手動で作成することをSphinxが想定しているのではないかと心配しています。 。

ただし、「automodule」ステートメントに気づき、クイックスタート中にautodocを有効にしたので、ほとんどのドキュメントが自動的に生成されることを期待しています。conf.pyを変更してsrcフォルダーをsys.pathに追加してから、index.rstを変更してautomoduleを使用しました。これで、私のindex.rstは次のようになります。

サブパッケージで定義されたクラスと関数は数十あります。しかし、私が実行すると：

それは報告します：

そして、これは私のパッケージ内に何かをインポートできなかったようです。生成されたindex.htmlを表示すると、「Contents：」の横に何も表示されません。インデックスページには「mypackage（モジュール）」のみが表示されますが、クリックすると内容が表示されません。

すべてのクラスを自分で手動でリストすることなく、パッケージを再帰的に解析し、検出したすべてのクラス/メソッド/関数のドキュメントを自動的に生成するようにSphinxに指示するにはどうすればよいですか？

いくつかの大きなアプリを含むプロジェクトがあり、設定ファイルとアプリ ファイルが分割されています。

ディレクトリ構造は次のようになります。

プロジェクト名

• _init_.py _ _
• アプリ
• _init_.py _ _
• アプリ1
• app2
• サードパーティ
• _init_.py _ _
• lib1
• lib2
• 設定
• _init_.py _ _
• installed_apps.py
• path.py
• テンプレート.py
• locale.py
• ...
• urls.py

どのアプリもそうです

• _init_.py _ _
• 管理者
• _init_.py _ _
• file1.py
• file2.py
• モデル
• _init_.py _ _
• model1.py
• model2.py
• テスト
• _init_.py _ _
• test1.py
• test2.py
• ビュー
• _init_.py _ _
• view1.py
• view2.py
• urls.py

スフィンクスを使用してドキュメントを自動生成する方法は?

設定モジュールまたは INSTALLED_APPS (django.* または 3rdparty.* で始まらない) ごとにそのようなものが必要であり、docstring に基づく自動ドキュメント出力が必要です。

自動生成ドキュメントと git commit の前にテストを実行

ところで。私は手動で.rstファイルをやってみました

しかし、そのような大きなプロジェクトにはうんざりで、設定には機能しません

autogenメソッドか何かがありますか？

私は Sphinx に縛られていません。私の問題に対するより良い解決策はありますか?

過去にこのトピックに関するスレッドがいくつかあり、Sphinxはこれをまったくサポートしていないと主張しています。私は疑問を持っていましたが、それ以降に更新されているか、ドキュメントがかなり隠されていました。これは、Webサイトに別の方法で記載されているリンクがあるためです 。http ：//www.sphinx-doc.org/en/master/usage/ restructuredtext / domains.html＃cpp-domain

とにかく、私はSphinxを初めて使用しますが、Sphinxを使用して、ソースC++コードからのテキストを使用してドキュメントを（最終的に）自動化しようとしています。sphinx-apidoc -o ...これまでのところ、コマンドを使用するとどこにも到達できませんでした。ほぼ空白のドキュメントが作成されます。方法がわからないので、おそらく正しいディレクティブを使用していません-サポートドキュメントは私を助けることができませんでした。

誰かがそれを機能させるために必要な基本的な手順でいくつかの支援を提供できますか？C ++からドキュメントを自動生成できない場合、C ++ドメインは何のためにあり、それらをどのように使用するのですか？

だから私は2つの異なるディレクトリに私のpythonソースファイルを持っています:-

例えば

sphinx-apidocreST ファイルを生成するために両方のディレクトリを再帰的に調べるにはどうすればよいですか?

明らかに、

完全に正常に動作しますが、実行しようとすると

繰り返しますが、sphinx は「docs/source/modules.rst が既に存在し、スキップしています」と表示します。これはもちろん、sphinx-apidoc一度実行して生成したことがあるからです。

では、一度実行して両方のディレクトリを検索するにはどうすればよいですか?

I'm building my sphinx doc for a django project the following way:

Now it includes all of the South migrations which I don't want to have in my documentation. I now tried to exclude them the following way:

Now they aren't documented anymore, but are still listed under modules. How can I exclude them?

実際のプロジェクトで行う前に、テスト Python プロジェクトのドキュメントを作成しようとしています。私のシステム: Win7 64 ビット、python 2.7.5 64 ビット。

私のプロジェクト名はtestDocです。tという名前の python パッケージが含まれており、2 つのモジュールt1とt2とが含まれています__init__.py。

__init__.py内容:

t1.py には以下が含まれます。

ドキュメントを作成するには、testDocのコマンド ラインで実行します。

Sphinx は多くのファイルを作成しますが、Sphinx のドキュメントによると問題ありません。次に、conf.pyを変更します。

docsフォルダーに入り、入力します

次の誤った出力が得られます。

どうしたの？ありがとう。

私は単一の .py モジュールしか持たない Python ライブラリに取り組んでおり、docstring からそのドキュメントを生成しようとしています。Sphinx をセットアップして、spinx-quickstart スクリプトを実行しましたが、実行しようとすると (docs ディレクトリで)

しかし、それはただ言う：

単一のファイルを autodoc する他の Sphinx スクリプトはありますか? 実行することだけを考え..ましたが、テストディレクトリに実行され、単体テストからドキュメントを生成しようとすると考えました...

クラスのない関数 (lib.py) を含む python ファイルがあります。各関数には次のスタイルがあります。

Sphinx を使用して各関数 (入力と出力) を文書化したいだけです。

sphinx-quickstartを実行した後、 lib.pyを使用して conf.pyにパスを定義しました。しかし、出力 HTML ファイル (ようこそページ) は空です。

index.rstに自分自身を書いた場合:

html ファイルに入力と出力が表示されます。しかし、それを自動的に行う方法は？

通常、 sphinx-apidoc -oを実行した後にlib.rstで実行する必要があると思いますが、lib.rstには次のようなものしかありません。

誰かが私が正確に何をしなければならないかを段階的に説明できますか?