問題タブ [autodoc]

Sphinx を使用して Python プロジェクトを文書化する必要があります。でも使えないautodoc。

プロジェクトを構成するときに「拡張 autodoc」オプションを選択しますが、今では使用する場合

エラーが発生します：

を設定しましたがPYTHONPATH、これで問題ありません。しかし、私はすでにこの問題を抱えています。

私のインデックスファイルは次のとおりです。

問題を解決する方法を教えてくれる人が必要です。

ありがとうございました

autodocSphinx を使用して Python プロジェクトを文書化しようとしていますが、拡張機能をnamedtuple生成されたクラスと組み合わせることができません。

ある文書にはgammatone.rst、次のものが含まれています。

私gammatone/coeffs.pyの には、次のものがあります。

によって生成されたコードにnamedtupleは、Sphinx のautodocモジュールが取得してインクルードする非常に一般的なドキュメント文字列が含まれています。autodocモジュールの残りの部分を無視せずに、自分でクラスを適切に文書化したいと思います。

クラスの直前に次のようなものを入れてみました：

...しかし、生成されたドキュメントには表示されません。クラスの後に置くと、それを置き換えるのではなく、ジェネリック クラスのドキュメントの下にネストされます。

によって生成されたものではなく、クラスautodocのドキュメントを使用するように Sphinx (および拡張機能) に指示するにはどうすればよいですか?ERBFilterCoeffsnamedtuple

私がこのようなクラスを持っているとしましょう：

autodocこのクラスを次のように文書化するために拡張機能を使用してSphinxを使用する場合：

...コンストラクターの署名はとして表示されMyClass(*args)ます。私はむしろこれを上書きして、たとえば、として文書化したいと思いますMyClass(first, second, third)。

これが関数の場合、docstringの最初の行の署名をオーバーライドできます。しかし、そのトリックはクラスdocstringでは機能しないようです。では、コンストラクターの署名をオーバーライドするにはどうすればよいですか？

私はlein-autodocを使用しようとしています。これは、Clojure の推奨されるドキュメント ジェネレーターであると考えているためです。:dev-dependencies [[lein-autodoc "0.9.0"]]lein-autodoc github ページの指示に従って、プロジェクト定義に追加しました。

実行lein depsは問題なく実行lein autodocされますが、autodoc はタスクではないと主張して失敗します。

問題は、lein-autodoc が leiningen 1 で動作するように設定されていることだと思います。しかし、私は leiningen 2 を使用しています。autodoc で lein を呼び出す別の方法はありますか? それとも、lein-autodoc パッケージが lein 2 で動作するように設定されていませんか? そうでない場合、別の推奨される lein2 互換のドキュメント生成オプションはありますか?

編集：

以下のCubicのヒントの後、次のように作成~/.lein/profiles.cljしました。

ここで、実行lein autodocすると次の結果が得られます。

これは、おそらく autodoc が Lein 2 と互換性がないことを示唆していますか? そうでない場合、Lein 2 で動作するドキュメント システムはありますか?

sphinx と autodoc プラグインを使用して、数千のクラスを含むプロジェクトの HTML ドキュメントを作成しようとしています。sphinx-apidocは素晴らしい rst ファイルを作成しますが、 autoclassesとautomethodsの自動作成が欠けています。

スフィンクスにすべての変数、関数、クラス、およびデコレータをドキュメントに自動的に含める方法/コマンド/ユーティリティはありますか?

1 つの rst ファイルのサンプル コード:

拡張機能でsphinxを使用しており、文書化されたメンバーではなく、いくつかのモジュールで文書化されていないメンバー関数のみautodocを含むリストを生成したいと考えています。

次のように、文書化されたメンバーと文書化されていないメンバーの両方を含むリストを正常に作成できます。

ディレクティブを単独で使用する:members:と、予想どおり、文書化されたメンバーのみのリストが作成されます。

しかし、:undoc-members:ディレクティブだけを使用した場合 (つまり、フラグを省略した:members:場合) は、まったくリストになりません。

これを自動的に生成する方法はありますか？

(主要なドキュメントには、ドキュメント化されたすべてのメンバーを表示するページが含まれていますが、ドキュメント化されていないメンバーをすべてリストする単一のページを作成することで、各関数などのドキュメントを作成したことを確認する方がはるかに便利です。それらのテキストは表示されません)文書化されています）。

Sphinxautodocを使用して、ソース内のドキュメント文字列から Python モジュールのドキュメントを生成しています。ディレクティブに a:synopsis:を含めることができることはわかっていますが、そのようなものは、すべてのドキュメントを docstring に入れるという を使用する目的を無効にします。automoduleautodoc

moduleだから私は次のようにファイルにディレクティブを追加しようとしました：

しかし、重複したモジュールについて「SEVERE」警告が表示されます。これは、モジュールを宣言していて、autodocそれも宣言しているためです。さらに、このようにすると、ファイル名からautodocモジュール名を特定するのではなく、モジュール名を指定する必要があるという点で、使用の目的が損なわautodocれます (大したことではありませんが、モジュールの名前を変更することにした場合モジュール、ここでも変更する必要があります)。

moduleauthorこのディレクティブに似たもの、modulesynopsisまたはディレクティブとして単独で使用できることを望んsynopsisでいましたが、Sphinx はこれらのいずれも認識していないようです。

を使用するときにdocstringに概要を含めることが可能かどうかは誰にもわかりautodocませんか?

次のように、Python モジュールで変数を文書化したとします。

モジュール文字列をドラッグしてドキュメント出力を生成することなく、.rst ファイルにその単一変数の autodoc を含めることはできますか?__doc__

私が試してみました

ただし、両方とも__doc__文字列をドラッグし、 の autodocs を表示しませんsome_random_name。

Sphinx を使用して「クラス」リスト/タブを表示する方法、またはクラスごとにメンバーを表示するために生成された html ページを整理し、クラスを視覚的に分離する方法はありますか?

私は Sphinx 1.1.3 を使用して、Python 拡張機能 (Cython で作成されたカスタム拡張機能) を文書化しようとしています。私の問題は、[モジュール] タブに入ると拡張機能全体が 1 つのブロックに表示され (これはまったく判読できません)、一方、[インデックス] タブではすべてがマージされます (これは正常です)。クラスごとの表示が必要です (Doxygen が行うことに近いもの)。

次のようなことをします：

存在しますか？

どうもありがとう。

インポートするモジュールのドキュメントを作成しようとすると、Sphinxはこのエラーをスローしますfrom google.appengine.ext import ndb。

yaml以前と同じ問題を含めることで修正しましsys.pathたが、では機能しませんgql。私は次のconf.pyように構成しました：