Publish your Java library with Sphinx

Your library already has Java sources and Javadoc comments. Your users also need examples that explain where to start and which API to choose. sphinx-java-autodoc brings both into one searchable Sphinx site: write the guides yourself and generate the API reference from the same sources you maintain.

See the result first: the example API is the complete public API of Apache Commons Lang, generated from its unmodified sources and Javadoc comments without running the library. Open StringUtils to see overloads, HTML tables, {@value} constants and links to standard Java types.

These docs are for Java library maintainers adopting the extension:

1. Publish your first API pages: install the extension and generate API pages from your sources.

2. Write a guide your users can follow: help a reader pick an API and complete a task, linking into the reference.

3. Build with dependencies and CI: add dependencies and generated sources, then publish the site from CI.

Extraction requires JDK 25; your library can still target Java 17 or 21. See Compatibility and limits for tested versions and known limits. The extension never runs application classes or annotation processors, and never downloads Java dependencies.

Publish your documentation

• Publish your first API pages
• Write a guide your users can follow
• Build with dependencies and CI

Reference and help

• Configuration and reference
• Supported Javadoc
• Compatibility and limits
• Performance measurements
• Troubleshoot a documentation build
• Choosing a tool

Live examples

• Feature gallery
• Java API: Apache Commons Lang

Project internals

• How it works