Generated Javadocs¶

The generated Java API reference is published beside the MkDocs site.

Public API reference¶

Use this for class signatures, methods, enums, inheritance, and package-level Java details.

Local artifact path¶

When you run ./gradlew buildReleaseArtifacts, the same reference is packaged at:

release/ziviDomeLive/reference/index.html

Publishing model¶

The GitHub Pages workflow generates Javadocs, builds the bilingual MkDocs site, and runs ./gradlew attachJavadocsToSite to publish one language-neutral reference at site/reference. Both languages use relative links to that canonical tree, so the same layout works at the project URL and inside pull-request preview subdirectories. After deployment, the button above resolves to the exact Javadocs for that commit.

For a local preview that includes Javadocs:

./gradlew javadoc --console=plain
python3 -m mkdocs build --strict
./gradlew attachJavadocsToSite --console=plain
python3 tools/validate_documentation.py --root . --site-dir site
python3 -m http.server 8000 --directory site