JythonプロジェクトでSphinxベースのドキュメントを作成するには？

Question

私はJavaで書かれたライブラリを使って、いくつかのJythonプロジェクトに取り組んでいます。私はautodoc拡張のおかげで、スフィンクスの良い文書をいくつか作ってみたいです。私は、HTMLを作成しようとするとautodocのは、Javaで書かれたライブラリを見つけることができないので、しかし、私はエラーを取得：

PoolManagerはJavaクラスです

sphinx-build -b html -d _build/doctrees . _build/html 
Running Sphinx v1.0.5 
loading pickled environment... done 
building [html]: targets for 1 source files that are out of date 
updating environment: 0 added, 1 changed, 0 removed 
reading sources... [100%] index 

/Users/myName/myJythonProject/doc/index.rst:14: (WARNING/2) 
autodoc can't import/find module 'myJythonProject', it reported error: 
"global name 'PoolManager' is not defined", 
please check your spelling and sys.path 

。

誰でもこの問題を解決するのに役立つでしょうか？

Answer 1

スフィンクスは、Jythonプロジェクトのドキュメントとして使用できますが、autodocはJavaで書かれたコードでは機能しません。 autodoc機能は、Pythonモジュールをインポートして検査します。 Javaクラスでも同じことをサポートしていません。

Java用のオートドック（または類似のもの）を実装することは実現可能なようですが、誰かがそれを行うためにボランティアをしなければなりません。 Sphinxの著者、Georg Brandl：http://www.mail-archive.com/sphinx-dev@googlegroups.com/msg03162.htmlからのコメントを参照してください。

autodocの複数言語サポートを実装することを目指して、a proposed GSoC 2010 projectについていくつかの情報が見つかりました。しかし、this blog postによれば、プロジェクトは完了していない。開発者は別のGSoCプロジェクトで作業することを選択しました。

sphinx-contrib repositoryには、autodocに関連するものは含まれていません。

---

更新

面白そうjavasphinxと呼ばれる新しいスフィンクスの拡張があります。私は、この拡張機能を使用していないが、the documentationによれば、JavaコードからのreSTソースを生成することができます：

javasphinx-apidocツールは、Javaドメイン内sphinx-apidocツール に対位法です。これは、既存の JavaソースコードからreSTソースを生成するのに使用できます。このソースコードには、Javadocスタイルのコメントがマークアップされています。生成されたのreSTは、Sphinxの手書き文書とともに処理されます。

javasphinxは別のライブラリjavalangを使用しています。

は、PyPIパッケージ：

• http://pypi.python.org/pypi/javasphinx
• http://pypi.python.org/pypi/javalang