codox icon indicating copy to clipboard operation
codox copied to clipboard

Multiple projects that share the same root index.html

Open timclemons opened this issue 4 years ago • 3 comments

I have several closely-related libraries where it would be nice to have a common set of docs for them. I'm currently using lein sub codox to generate these docs but I was wondering if there was a way to aggregate the outputs of these into a common folder with a index.html file which lists all the projects in a sidebar.

timclemons avatar Oct 30 '20 22:10 timclemons

Nothing that automatically does this, but you could write your own index page and use the HTML transformation options to incorporate the upddated sidebar into the docs of the subdirectories.

weavejester avatar Oct 31 '20 02:10 weavejester

If they're all "sub-projects" (with lein-sub or lein-modules) then you can use the same approach as Pedestal: https://github.com/pedestal/pedestal/blob/166d788dc0c6a40184bb4c105c100db803235df8/project.clj#L25-L46

dcarley avatar Nov 18 '20 11:11 dcarley

@dcarley Interesting, I think that might just do the trick. Thanks for the tip!

timclemons avatar Nov 19 '20 01:11 timclemons