Example: Apache Commons Lang

Browse the API in Furo, Read the Docs, Alabaster or Lumina: the same generated pages in four themes, with no theme-specific configuration. It’s version 3.21.0 of Apache Commons Lang, about 260 source files, generated from unmodified sources. Apache Commons Lang is licensed under the Apache License 2.0; this site is not affiliated with the Apache Software Foundation.

It uses the Generate your API pages configuration plus java_external_javadoc for JDK links and sphinx.ext.linkcode for source links to GitHub at the pinned commit. For an example of every feature, see the Feature gallery. The build reports 172 warnings:

  • 98 java.inherit: overrides of JDK methods that cannot inherit their documentation, because the JDK’s sources are not available.

  • 8 java.extract: links to libraries not on the classpath, and {@inheritDoc} with no ancestor source.

  • 31 java.html: headings and other unsupported HTML.

  • 20 highlighting failures: <pre> examples that are not Java.

  • 15 ref.*: links to private members and to libraries not on the classpath.