問題タブ [epydoc]

1 つのモジュールのドキュメントについては、epydoc を検討しています。私には問題ないように見え、htmlドキュメントを生成しているときにうまく機能しています。

ドキュメントをpdf形式で生成したいと思います。構成ファイルの「出力」設定を変更しました。

残念ながら、epydoc は pdf ファイルの生成に失敗します。エラーは「エラー: pstat ファイルの読み取りエラー: [Errno 2] そのようなファイルまたはディレクトリはありません: 'profile.out'」です。

いくつかの tex ファイルを生成します。ラテックスが不足していると思いますが、テックスとラテックスにはあまり詳しくありません。さらに、私はWindowsで作業しています。

epydocを生成するpdfファイルを作成するための次のステップは何ですか?

よろしくお願いいたします。

コードをepydocロードして最上位モジュールをロードすると、次のように失敗します。

それが参照している は、9 行目にロードしようとしたサブモジュールです。epydocNoneTypeに、9 行目にモジュールをロードできなかった理由を説明させるにはどうすればよいですか?

noskoさんのリクエストで。次に、スタック トレースが指定されていない同様の例を示します。

実行:

役に立たないものを生成します：

失敗が の 6 行目にあることを epydoc に教えてもらいたいですbar.py。foo.pyの のインポートについて不平を言いたくありませんbar.py。小さな例で特定の問題を再現することはできませんが、私の基本的な要求は、epydoc が失敗したときに、スタック トレースを出力して問題を指摘することです。サブモジュールをロードしているか、辞書でキーが見つからないかを呼び出します。

注: この問題の根本は、私が文書化しようとしているコードが、さまざまな環境セットアップの問題を持つ SCons への入力であることです。そのため、実行するepydocと機能しませんが、で実行するとスクリプトは引き続き機能しますscons -f SConstruct.py。でドキュメントを生成しようとしていsphinxます。sphinx実際に実行すると、スタックトレースが表示されます。多分私は一緒に行くでしょうsphinx...

Python 用のドキュメンテーション ツールはたくさんあるようです。私が遭遇した別のものはepydocです。Sphinx は、公式の Python ドキュメントを生成するために使用されているため、デファクト スタンダードのようです。誰かが私のために Python のドキュメンテーション ツールの現在の状態を整理してくれませんか?

複数のグローバル関数とグローバル変数を含むモジュールがあります。変数と一部の関数は、Python の「プライベート」命名規則に従い、名前の先頭にアンダースコアを付けます。他の関数はパブリックであることを意図しており、先頭にアンダースコアはありません。

__all__ファイルの先頭で、パブリック関数名のリストを使用して を宣言しました。

epydocを使用してこのモジュールのドキュメントを生成しようとすると、epydoc はモジュール内のすべてを非公開と見なします。また、--no-privateフラグを使用しているため、出力にはモジュール自体のドキュメントのみが表示され、モジュールの要素や個々のドキュメントは表示されません。

--no-privateepydoc でフラグを使用しない場合、すべてが文書化されます。しかし、私はそこに私的なものを望んでいません。ここにキッカーがあります:をコメントアウトすると__all__、epydoc はモジュールのパブリック要素のみを正しくドキュメント化します。

私は比較的Pythonの初心者ですが、私が理解しているように、__all__他のモジュールをインポートしてから他のモジュールがあなたのモジュールをインポートするときに問題が発生しないようにするためのものであり、すべてが技術的に公開されているときに物事をよりしっかりとカバーしようとするためのものです.アクセスしようとしているものの名​​前を知っている限り。省略__all__すると、Bad Things™ につながる可能性があると言われています。同時に、epydoc は、__all__何が公開され、何が公開されていないかを決定することを尊重すると主張しています。

__all__私のコードでの の使用法や epydoc のバグについて間違っていると仮定して、epydoc を間違って使用しているのですか? (新しいバージョンの docutils が原因であると思われる epydoc のエラー処理バグを 1 つ解決済みです。)

構成ファイルに依存するソフトウェアコンポーネントを作成しました。わかりやすくするために、関連するクラスのdocstringにサンプルファイルを追加して、構成ファイルの構造を文書化します。明らかな理由で、固定幅フォントで表示する必要があります。

私が知っている唯一の方法は>>>、各行の前に追加することです。これは、doctestがこれがPythonコードセグメントであると見なし、その知恵を失う可能性があるため、悪いことです。さらに、それは本当に醜いように見えます：

>>>[db]

>>>ポート=5432

>>>名前=adam_db

...

私が本当に欲しいのは：

[db]

ポート=5432

name = adam_db

..。

固定幅フォント。

何か案は？

ありがとう、

アダム

私はepydocでreStructuredTextを使用しています。内部リンクのテキストをリンクのターゲットとは異なるものにするにはどうすればよいですか? 私は持っている：

Product リンクは正常に見え、Product オブジェクトにリンクしています。Product.manufacturer リンクは適切なメンバー変数に移動しますが、テキストが Product.manufacturer ではなく、単に製造元になりたいと思います。

これは、epytext を使用すれば実行できることはわかっていますが、必要に応じて後でドキュメント ジェネレーターを切り替えることができるように、reStructuredText を使い続けたいと考えています。

私は、マニュアル QA が時々読めるようにしたい機能テストの広範なセットを含む pylons プロジェクトを持っているので、epydoc を使用して機能テスト モジュールで html pydoc を構築しています。

うまくいっているようです。ドキュメントが生成され、明らかな問題なくドキュメントをナビゲートできます。

ただし、epydoc ビルドを実行すると奇妙なエラーが発生し、修正方法がわかりません。

p>

これが発生しているパッケージは合計 2 つ、モジュールは 8 つです。最初は、モジュールの先頭またはパッケージの __init__ に docstrings がない可能性があると思いましたが、それらを追加しても修正されませんでした。

以下は、機能テスト用に特別に記述された epydoc 構成ファイルのコピーです。

そして、これを実行するために使用されるシェル スクリプトのコピーを次に示します。

助言がありますか？

コード ライブラリのエピドキュメントを生成していますが、含まれたくないいくつかのテスト ファイルがあちこちに散らばっています。生成オプションを使用し--excludeてファイルの名前を変更することもできますが、そのファイルを含めたり解析したりしないコマンドとして epydoc によって解釈されるファイル自体に追加できるものがあるかどうか疑問に思っています。

私はreStructuredTextを使用してコードを文書化し、epydocを使用してオフラインのHTMLページを取得しています。

結果は素晴らしいです。唯一の欠点は、Pythonインタラクティブシェルを使用すると、help（）関数がドキュメント文字列のreSTメタデータを解析せず、代わりにすべてをそのまま表示することです。

docstringの最小限の解析を行うためにhelp（）を使用する方法はありますか？

イタリックフォントやハイパーリンクのレンダリングは期待していませんが、読みやすさを向上させるために少なくともいくつかの最小限のクリーンアップを期待しています。

過去 2 年間、epydoc を使用していませんでしたが、非常に簡単に自分のクラスとメソッドを追跡できることが非常に便利であることがわかりました。

今日、最新バージョンをインストール3.0.1しましたが、このエラーが発生し、検索しても解決策がないようです。

epydoc プロジェクトは終了していますか?