如何在 Jython 项目中创建基于 Sphinx 的文档？

Question

我正在使用 Java 编写的库处理几个 Jython 项目。 由于 autodoc 扩展，我想用 Sphinx 创建一些好的文档。 但是，当我尝试创建 html 时，出现错误，因为 autodoc 找不到用 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

其中 PoolManager 是一个 Java 类。

谁能帮我解决这个问题？

Answer 1

Sphinx 可用于记录 Jython 项目，但autodoc不适用于用 Java 编写的代码。 autodoc 功能导入并检查 Python 模块。 不支持对 Java 类执行相同操作。

为 Java 实现 autodoc（或类似的东西）似乎是可行的，但必须有人自愿去做。 请参阅 Sphinx 作者 Georg Brandl 的此评论： https : //www.mail-archive.com/sphinx-dev@googlegroups.com/msg03162.html 。

我发现了一些有关提议的 GSoC 2010 项目的信息， 该项目旨在实现对 autodoc 的多语言支持。 但是根据这篇博客文章，该项目尚未完成。 开发人员选择从事另一个 GSoC 项目。

sphinx-contrib 存储库不包含与 autodoc 相关的任何内容。

---

更新

有一个名为javasphinx的新 Sphinx 扩展看起来很有趣。 我没有使用过这个扩展，但根据 文档，它可以从 Java 代码生成 reST 源：

javasphinx-apidoc工具是 Java 领域中sphinx-apidoc工具sphinx-apidoc 。 它可用于从已用 Javadoc 样式注释标记的现有 Java 源代码生成 reST 源代码。 然后生成的 reST 与 Sphinx 的手写文档一起处理。

javasphinx 使用另一个名为javalang 的库。

PyPI 包：

• https://pypi.org/project/javasphinx/
• https://pypi.python.org/pypi/javalang