問題タブ [epydoc]

複数のクラスを含む python ファイルがあり、epydoc を使用してコメントからドキュメントを作成したいと考えていました。だから私は私のDebian wheezyシステムのコンソールで行います:

常に Python アプリケーションを実行し、ドキュメントの生成は 21% で停止します。epydocgui を使用した場合と同じ動作です。

単純な hello world プログラムでテストすると、すべて正常に動作します。ファイルが 1000 行を超えているため、投稿できません。プログラム自体は正常に動作します。

なぜそれが起こるのですか？まだ見つかっていませんが、間違ったフォーマットが問題になる可能性があります。

Thx 4 ヘルプ

によって生成された python モジュールの html 形式のオンライン マニュアルがあり、epydoc 3.0.1それを に変換したいと考えていpdfます。たとえば、epydocそれ自体のドキュメントはhtmlとpdfの両方で利用できます。フォーマットで維持されているドキュメントをhtmlフォーマットに変換する方法はありpdfますか?

(実際、マニュアルのすべてではなく、一部のセグメントのみに関心があります。PDF に追加する HTML ページを選択できれば、すばらしいことです)。

epydoc を使用して関数で定義されたインスタンス変数を文書化する方法。以下を使用しましたが、生成されたhtmlドキュメントの変数セクションにのみ__package__ = None表示されます。

これは EpyDoc Web サイトで指定されています。

変数は、コメント docstring を使用して文書化することもできます。変数の代入の直前に特別なマーカー '#:' で始まる行を持つコメントがある場合、または同じ行でそのようなコメントが続く場合、それはその変数の docstring として扱われます。

ドキュメンテーションを生成する毎晩の epydoc ジョブがありますが、docstring テストも実行したいと考えています。ドキュメントを作成するすべてのファイルに対して docstring テストを自動的に実行する方法を知っている人はいますか?

このコードをepydocのメインブロックに挿入してみました

しかし、役に立たない。そのブロックで doctest を探しますが、当然何もありません。私はこの出力を得る：

epydoc と Sphinx の両方のドキュメント ジェネレーターを使用すると、コーダーは任意/すべての関数パラメーターの型に注釈を付けることができます。

私の質問は: docstringに文書化されているときに、これらの型を (実行時に)強制する方法 (またはモジュール) はありますか? これは厳密な型付け(コンパイル時チェック) ではありませんが、(より可能性が高い)厳密な型付け(実行時チェック) と呼ばれる可能性があります。たぶん「ValueError」を発生させるか、さらに良いことに...「SemanticError」を発生させます

理想的には、 xkcdimport antigravityによる " " モジュールに似たもの (モジュールのようなもの)がすでに存在し、この "firm_type_check" モジュールは、ダウンロードできる便利な場所に既に存在しているはずです。

参考: epydoc と sphinz のドキュメント文字列は次のとおりです。

epydoc: 関数とメソッドのパラメーター:

• @param p: ... # 関数またはメソッドのパラメーター p の説明。
• @type p: ... # パラメータ p の予想される型。
• @return: ... # 関数またはメソッドの戻り値。
• @rtype: ... # 関数またはメソッドの戻り値の型。
• @keyword p: ... # キーワード パラメータ p の説明。
• @raise e: ... # 関数またはメソッドが例外 e を発生させる状況の説明。

Sphinx: Python オブジェクト記述ディレクティブ内で、これらのフィールドを含む reST フィールド リストが認識され、適切にフォーマットされます。

• param、parameter、arg、argument、key、keyword: パラメータの説明。
• type: パラメータのタイプ。
• raises、raise、except、exception: 特定の例外が発生したとき (および発生したとき)。
• var、ivar、cvar: 変数の説明。
• return, return: 戻り値の説明。
• rtype: 戻り型。

私が見つけた最も近いものは、mail.python.org で Guido によって言及され、Mypy Examplesで Jukka Lehtosalo によって作成されたものでした。 CMIIW : mypy は py3 モジュールとしてインポートできません。

docstring自体を使用しない同様のスタックオーバーフローの質問:

• パラメーターの型を確認する Python の方法
• Pythonで型をチェックする標準的な方法は何ですか?

文書化しようとしている Python パッケージがあり、インポート中のサブパッケージを非表示にしたいと考えています。

構造：

shapefile フォルダは、restapi__init__.pyおよびその他の .py ファイルが存在するディレクトリにあります。コマンドラインからepydocを使用してこれを除外するにはどうすればよいですか?

これまでのところ、私はこれを行ってきました：

epydoc GUIを使用してまったく同じファイルを参照すると、これを機能させることができますが、cmdから実行すると、shapefile単なる依存モジュールである のドキュメントが追加されます。open_restapi.py ファイルからインポートされているため、シェープファイルが含まれていると思います

エピテキストで変数の型を関数またはインスタンスメソッドとして指定する正しい方法は何ですか?

私はこれを見ました：

そして私はこれも見ました：