Spring Modulith Docs as maven report

[wolframhaussig]

I am starting to use Spring Modulith in a small project to check it out and I find it very helpful so far. But I have a minor wish for the documentation: I am using mvn site to generate the documentation of my project but this does not contain the module documentation. Would it be possible to create a maven report plugin to add the module docs to the maven generated documentation?

[khmarbaise]

The modulith docs are asciidoc parts (PlantUML, asciidoctor) If you use asciidoctor-maven-plugin (see for details https://github.com/asciidoctor/asciidoctor-maven-examples/tree/main/asciidoc-maven-site-example) it can be integrated into the site as well (you can write asciidoc for the site parts instead of apt, markdown etc.). The option to generate the javadoc including umldcolet can be integrated into the site anyway...

[odrotbohm]

I currently don't think we want to expand the scope of our functionality into build system-specific extensions. As Karl Heinz pointed out, we're generating PlantUML and Asciidoc files into well-known locations. You should be able to configure your build system to pick those files up from those locations. A common pattern is to include both the PlantUML and Asciidoc files into a central file rendered by the Asciidoctor Maven plugin for downstream consumption.