Publish your Java library with Sphinx

sphinx-java-autodoc puts your handwritten guides and an API reference generated from your Java sources and Javadoc into one searchable Sphinx site.

See the result first: the example is the complete public API of Apache Commons Lang, generated from its unmodified sources. Open StringUtils to see overloads, HTML tables, {@value} constants and links to JDK types. The feature gallery shows each feature next to its source, and Compare with other tools compares other tools.

To adopt the extension, follow three steps:

1. Generate your API pages from your sources.

2. Write a task guide that links into the reference.

3. Add dependencies and publish from CI.

Extraction requires JDK 25; your library can still target Java 17 or 21. It never runs application classes or annotation processors, and never downloads Java dependencies. Settings, roles and limits are under Reference.

Evaluate

• Example: Apache Commons Lang
• Feature gallery
• Compare with other tools

Adopt

• Generate your API pages
• Write a task guide
• Add dependencies and publish

Reference

• Configuration reference
• Supported Javadoc
• Compatibility and limits
• Troubleshooting

Project

• Performance
• How it works