Documentation

Individual files

gradle vodmlDoc 

will generate standard documentation into the directory build/generated/docs/vodml/ (this can be changed with the outputDocDir setting)

This will produce a model diagram, latex and html formatted documentation, as well as a graphml representation of the model that can be hand edited with yEd for nicer looking model diagrams.

Site

gradle vodmlSite

Will generate a whole static site describing the model that is intended to be further processed with mkdocs tool that is configured with the material theme.

The site is generated at in the build/generated/docs/vodml-site/ directory (which can be changed with the outputSiteDir setting). If you are creating full documentation site, then it is likely that you will want to add content other than the autogenerated model description. In this case the tools have an assumption that the outputSiteDir is set to a generated sub-directory of your configured mkdocs top-level directory.

The plugin will create an allnav.yaml file in the project directory which can be added to the mkdocs navigation using yq by adding the following to the build.gradle.kts

tasks.register<Exec>("siteNav")
{
    commandLine("yq", "-i",  "(.nav.[]|select(has(\"AutoGenerated Documentation\"))|.[\"AutoGenerated Documentation\"]) += load(\"allnav.yml\")", "mkdocs.yml")
    dependsOn("vodmlSite")
}

which in turn assumes that there is an "AutoGenerated Documentation" section in the mkdocs nav that can be added to.

nav:
  - Home: index.md
  - AutoGenerated Documentation:
      - Javadoc: generated/javadoc

The DataModel Template has an example setup.