問題タブ [autodoc]

私はこのようなクラスを持っています：

そしてそれを継承する別のクラス：

sphinxのautodocを使用してドキュメントを生成すると、ドキュメント化されMyObj.xません。docstringをから継承する方法はありますMyBase.xか？DocInheritを見つけましたが、これはデコレータを使用しているため、クラスメソッドに対してのみ機能します。プロパティでこれを行う方法はありますか？

デフォルトでは、Sphinx は __init__(self) のドキュメントを生成しません。私は次のことを試しました：

と

conf.py では、次のように設定すると、__init__(self) docstring がクラス docstring に追加されるだけです ( Sphinx の autodoc ドキュメントでは、これが予期される動作であることに同意しているようですが、解決しようとしている問題については何も言及されていません)。

Python 3 でプログラムを作成し、Sphinx を使用して文書化しています。Sphinx の autodoc は優れていますが、Python 2 でしか動作しません。一部のモジュールは autodoc で正常に動作しますが、モジュールは動作しません。いくつかの例: Python 2 は、Python 3 スタイルのメタクラス、およびconfigparserなどの Python 2 にはもう存在しないいくつかのモジュールについて不平を言います。そのファイルからdocstringをインポートできないため、これは面倒です。

Python 2 でプログラム全体を書き直すつもりはありませんが、autodoc を使用したいと考えています。

私が思いついたアイデアの 1 つは、各 Python ファイルを読み取り、すべての機能を削除し、基本的な関数とクラスをドキュメント文字列と共に残す小さなプログラムでした (autodoc は各モジュールをインポートし、特定の関数またはクラスのドキュメント文字列を読み取るため)。

の中へ...

このようにして、処理されたコードはautodocで読み取ることができますが、私が本当に必要としているdocstringをまだ持っています. これが最善の方法ですか?コードを変換する小さなプログラムの書き方について何か提案はありますか?

いくつかの正規表現でメタクラスの問題を非常に簡単に取り除くことができますが、残りは苦労しています。

astモジュールは役に立ちますか?

ありがとう。

スフィンクスを使用してドキュメントを自動生成します。「make html」を実行すると、次のエラーが発生しました。

http://jaredforsyth.com/blog/2010/apr/28/accessinit-hash-collision-3-both-1-and-1/で関連記事を見つけました。衝突を引き起こすのは、PIL をインポートするさまざまな方法であると述べています。この記事で述べたとおりに Docutils と Pygments にパッチを適用しましたが、それでも上記のエラーが発生します。

誰でもこの問題を解決する方法を教えてもらえますか?

Leiningenを使用しているときに、次の突然のエラーが発生しました。

スレッド「main」の例外java.lang.NoSuchMethodError：org.apache.tools.ant.util.FileUtils.getFileUtils（）Lorg / apache / tools / ant / util / FileUtils; （core.clj：1）

https://github.com/technomancy/leiningen/issues/194で次の回答を見つけました：

https://github.com/technomancy/leiningen/blob/master/doc/tokyo.mdのLeiningenチュートリアルと、https：//github.com/technomancy/leiningen/blob/stableのサンプルproject.cljファイルを読みました。 /sample.project.cljですが、まだ次の質問があります。

1）上記の1とマークされた行では、jarファイルの特定のバージョンを除外する方法がわかりません。

2）上記の2で、正確には何bin/leinですか？私のLeiningenプロジェクトにはbinディレクトリがなく、Leiningen自体はスクリプトなので、binディレクトリはありませんか？

助けてくれて本当にありがとうございます。

補遺8/6/11：Autodocの特定の問題について、問題を修正するAutodocのフォークを見つけました。「[org.clojars.weavejester/autodoc"0.9.0"]」をproject.clj>defproject>:dev-dependencies句に追加するだけです。次に、コマンドラインから（ディレクトリがleiningenプロジェクトのルートと等しい）、「lein autodoc」を実行し、しばらく待ちます。

Sphinx でプロジェクトのドキュメントを作成しようとしていますが、Sphinx がモジュールで OptionParser に遭遇するたびに、次のようになります。

sphinx-build: エラー: そのようなオプションはありません: -b

私はそれは不可能だと思ったので、これをチェックするための簡単なモジュールを書きました:

そして、それは私に同じエラーを与えます。私の最初は次のようになります：

「WCF REST サービス テンプレート 40」を使用して作成された REST サービスのドキュメント ツールを探していて、Autodocs (http://autodocs.codeplex.com/) に出会いましたが、それらが連携して機能するかどうかはわかりません。 ....

それを機能させた人、またはドキュメントに使用する別のツールへの提案 (C# API ではなく、ドキュメント化されるのは REST サービスであることが重要です)

ティア

セーレン

私はSphinxのautodoc機能を使用してAPIを文書化しています。

例：

生成されたドキュメントには、次の署名が表示されます。

Sphinxに定数値の名前を保持するように指示するにはどうすればよいですか？

？

私が見落としたオプションはありますか？できれば、すべての署名を手作業で書き直したくない。

Sphinx で文書化しようとしている Google App Engine プロジェクトがあります。多くのモジュール/クラス/関数でautodoc機能を使用しようとしています。

私の Sphinx reST マークアップ:

を実行するmake htmlと、次のエラーが表示されます。

このファイルはwebapp2urlsをインポートします。これは、今度は appengine.api をインポートしようとするでしょう。私のに提供することは不可能だと思います。回避策はありますか？appengine.apisys.path

PS。私はスフィンクスと結婚していません。私はepydocまたは代替案に対してオープンです。

ドキュメント生成には Doxygen ツールを使用しました。しかし後になって、Apple 自身が「ドキュメンテーション セット ガイド」を提供していることを知りました。

参照リンクは次のとおりです 。

これについて知っている人はいますか-これとすべてを使用する方法はありますか? 自動生成されたドキュメントの作成に役立つかどうか?

前もって感謝します、

ムルナル