問題タブ [autodoc]

モジュールのインポート部分を除外し、それをsphinx-pythonで文書化する方法はありますか？別のパッケージ（他の別のプロジェクト）をインポートするモジュールがあり、スフィンクスはこのエラーを出します：

"""ファイル"/usr/local/lib/python2.7/dist-packages/Sphinx-1.1.3-py2.7.egg/sphinx/ext/autodoc.py"、行321、import_object import（self。 modname）ファイル "/home/x/GitHub/project/mod_example1.py"、33行目、other_pckからインポートKlass、KlassStuff ImportError：other_pckという名前のモジュールはありません "" "

そして、スフィンクスがautodocを実行できるパッケージを呼び出す/インポートするモジュールのインポート部分にコメントすると、すべてのsphinxautodocモジュール（autoclass、automoduleなど）を試してみましたが、他のパッケージをインポートしようとすると、結果は常に同じになります。

ありがとう

http://www.rbt.ca/autodoc/index.htmlから最新のPostgresqlAutodoc（v1.41）をダウンロードしました。make
を実行すると、次のエラーが発生します。

何が問題ですか？

Mac OS X Lion、10.7.5
GNU Make 3.81

こんにちは私はスフィンクスを使用してDjangoプロジェクトのドキュメントを書いています。

私のプロジェクト（Django 1.4）は次のようになります：

conf.pyにスフィンクスのセットアップがあります：

したがって、私のスフィンクスソースファイルでは、これを行うことができます：

これは正常に動作します。ただし、次の2つの例は機能しません。

1.1。

2.2。

2つ目は、fabfileをapp1に移動して使用する場合に機能しますapp1.fabfile

何か問題があると思いconf.pyますが、多くの派生を試しましたがfabfile.py、アプリディレクトリの下にない限りインポートできません（ただし、下/funprojectでも機能しません）。

これに関する助けをいただければ幸いです。

sphinxautodoc拡張機能を使用してドキュメントを作成する場合、(クラス自体ではなく) クラス インスタンスを関数のようにドキュメント化するにはどうすればよいですか? クラスには__call__メソッドが定義されています。

RPi.GPIO モジュールを使用する Python で記述された Raspberry Pi プロジェクトがあります。コードのすべての作業は、RPi.GPIO がインストールされない Windows ボックスで行われ、autodoc を実行しようとするたびに、RPi.GPIO をインポートできないと言ってクラッシュします。

これを回避する方法はありますか？

JSONファイルを生成するためにSwagger-PHPを使用しようとしているので、自動ドキュメント用のSwagger-UIで使用できます。

リンクを試してみました:- https://github.com/zircote/swagger-php

また、 http://zircote.com/swagger-php/installation.htmlにあるドキュメントを回避しようとしました。

しかし、私の運が悪かったので、実装できません。

composer を正しくインストールできます。また、Swagger-PHP のバンドルも正しくインストールされています。

しかし、問題は、提供されたテスト例を使用/理解できないことです。

誰かがそれを回避した場合は、助けてください!!

前もって感謝します ！！

Python の文書化に rST/Sphinx を使用していますが、ビルド時に次のような警告が表示されます。

私のPythonソースファイルは次のように文書化されています:

rST ファイルは、autodoc が提供するautomoduleディレクティブを使用して、すべての docstring を取り出し、すべてのメンバーを文書化します。

上記のコンボは問題なく動作しているように見えますが、エラーはこれを行う適切な方法があることを暗示しているようです。ソース ファイルの先頭からモジュール ディレクティブを削除すると、エラーはなくなりますが、Sphinx が取得したソースに概要オプションを追加できません。

現在、Django プロジェクトのドキュメント用に Sphinx を評価しています。これは、プロジェクトに緊密に結合された複数のアプリで構成されています。私が達成しようとしていることの 1 つは、カテゴリ別にグループ化されたドキュメントのページを生成することです。これはすべて手動で行うこともできますが、自動化できることを願っています。

具体的には、定期的に生成される autodoc ドキュメントに加えて、すべての概要を提供するドキュメントのページが欲しいです...

• モデル
• ミドルウェア
• ビュー
• コンテキスト プロセッサ
• 信号
• テストケース

のような典型的なアプリ構造から

および（おそらく）docstring

次のようなドキュメントでのレンダリング

ビュー

myapp. views.MyView

このビューに関する情報。

otherapp. views.OtherView

この OtherView に関する情報。

django-sphinx-autodocは、おそらくアプリを見て回るのに役立つでしょう。私がやりたいことをするためにdjango-sphinx-autodocを拡張/変更する必要がありますか? これを取得するための他のアプローチをアドバイスしていただけますか？それとも、これをすべて手動で行うのが唯一の方法ですか?

次のような 3 層のクラス構造があります。

私のindex.rstファイルは次のようになります。

Sphinx は、すばらしい API ドキュメントを生成してくれます。これには、クラスSuperとが含まれSub、適切なコメントが付けられています。コメントがなく、フラグIntermediateを提供しなかったため、含まれていません。これは、ドキュメントに表示されundoc-membersたくないためです。Intermediate

私の問題は次のとおりです。show-inheritanceフラグを提供するため、Sphinx は各クラスのベースを表示します。とのobjectために。文書化されていないため、基本クラスのリストに表示したくありません。代わりに、Sphinx が継承ツリーの次の文書化されたクラスを表示するようにしたいと思います。つまり、Sphinx にの基底クラスとしてではなく、を表示させたいのです。SuperIntermediateSubIntermediateSuperSuperIntermediateSub

誰もこれを行う方法を知っていますか?