問題タブ [epydoc]

私のクラスには、クラスの他のメソッドでのみ使用されることを意図したメソッドがいくつかあります。名前の前に「_」を付けました。これらの関数をepydocから非表示にできますか？それは良い考えですか？

'_'または二重アンダースコアを使用する必要がありますか？正直なところ、いくつかの場所でそれらについて読んだ後、私は違いを理解しませんでした。この命名規則は、モジュール/クラス（インスタンス）関数でのみ使用する必要がありますか？または変数も？

私は、epydoc を使用して文書化したプロジェクトを持っています。今、私はスフィンクスに切り替えようとしています。太字やリンクなどに B{}、L{} などを使用し、入力、出力、例外などを説明するために @param、@return、@raise などを使用して、epydocs 用にすべてのドキュメント文字列をフォーマットしました。

そのため、Sphinx に切り替えると、これらの機能がすべて失われます。epydocs 用にフォーマットされた docstring を sphinx 用にフォーマットされた docstring に自動的に変換する方法はありますか?

Epydoc is not working good anymore, even after applying patches, so I'm trying to move to Sphinx.

I want to auto-generate documentation from a simple python file: test.py

After installing and running sphinx-quickstart-script I copied test.py to the source folder and typed:

sphinx-build -b html .\source .\build

But it only produces the minimiun html files, and it does not parse the test.py file

I'm run out of ideas.

Thanks for your help :)

Epydocのドキュメントdotgraphには、ディレクティブを使用してソースコードにGraphviz図を含めることができると記載されています。

ただし、これを試してみると：

私が得るのは、単に「。」というエラーUnknown directive type "dotgraph"です。最新epydoc（v3.0.1）を使用しdotており、システムに正しくインストールされています。

どうすればepydoc図を作成できますか？

ビルドされたsconsからepydocまたは/およびpylintを実行するビルダーを作成するにはどうすればよいですか?

docsパッケージの epydoc を実行するターゲット (たとえば) が必要です。新しいコマンドを作成する必要があると思いますが、うまくいきません。

誰もこれを以前にやったことがありますか？

不足しているものはありませんが、次のコード:

ドキュメントの生成時に次のepydocエラーが発生します。

@abstractpropertyデコレータをデコレータに変更すると、警告が消え@propertyます。私の質問は、これがバグなのか、それとも何か不足しているのかということです。

バージョン 3.0.1 の epydoc を使用します。

私はこの簡単なことを試しました：

これを実行しました：

しかし、epydoc によって作成された html では、メソッド プロトタイプは、記述されたパラメーターの代わりに 3 つの連続したドットで表示されます。

何か案が ？どうもありがとう

編集：申し訳ありませんが、完全に機能する簡単なスクリプトをテストしました。Cython でコンパイルされた共有オブジェクト (.so) であるため、前のケースは機能しませんでした。それは違いを生みます。ソースも表示できません。関数プロトタイプの解析に関して、epydoc は docstring のみに取り組んでいると思っていましたが、それよりも少し複雑なようです...

EDIT2：さらに、「embedsignature」cythonコンパイルディレクティブを「True」に渡してコンパイルすると、何かが得られます-これはまだ間違っていますが、現象をよりよく理解しています：

別名 : epydoc は、cython 化された署名が埋め込まれている方法を理解していません...

もっと具体的な説明があれば、私はまだあなたの男です. ありがとう

すべてが問題です: epydoc の生成された html ページの favicon を変更するにはどうすればよいですか?

注：cssコンテンツをカスタマイズする方法を見ましたが、出力htmlファイルのカスタマイズについては何も知りませんでした...

どうもありがとう。

私は、エンドユーザーが読むことができるはずの Python のメソッドのドキュメントを書いています。Epydocフィールドタグを使用して、与えられた要件に基づいて引数を文書化し、メソッドの説明とメソッドの使用例の間にパラメーターの説明を入れようとしています。

残念ながら、type タグから例を除外する方法を見つけることに成功していません。パラメータを引数の最後に移動しないようにしています。ドキュメントのタグを終了し、それに続くテキストを除外する方法はありますか?