Logo Questions Linux Laravel Mysql Ubuntu Git Menu
 

How to merge documentation from SBT multi-projects?

I am generating the ScalaDoc HTML files for some SBT projects (in a Multi-Project configuration). If I execute doc in the SBT console, the documentation is generated nicely, but it is deployed in a standalone directory for each project. Since all the projects are quite related each other (in terms of package names), I would like to generate a unique ScalaDoc directory as output. It worths mentioning that I can not put all the sources together because of the dual compilation process required by some involved macros. Is there any workaround to do so?

like image 618
jeslg Avatar asked Apr 16 '13 14:04

jeslg


1 Answers

Unfortunately, scaladoc doesn't work with separate compilation since it cannot merge generated documentation. The docs have to be generated for all sources at once. The solution to the macro problem is to use -Ymacro-no-expand to not expand macros during scaladoc generation. See also https://issues.scala-lang.org/browse/SI-6812

like image 80
Mark Harrah Avatar answered Oct 26 '22 09:10

Mark Harrah