Getting Started¶
Prerequisites¶
- Java 11+
- Maven 3.8+
Common commands¶
Build and test:
mvn clean verify
Generate JavaDoc only:
mvn javadoc:javadoc
Local docs preview¶
Install docs dependencies:
pip install mkdocs mkdocs-material
Run local docs server:
mkdocs serve
Then open http://127.0.0.1:8000.
API docs¶
Generated JavaDoc is available from the API Reference page.