Documentation framework?

6 views
Skip to first unread message

shi...@gmail.com

unread,
Jun 19, 2014, 2:24:37 PM6/19/14
to jooq-de...@googlegroups.com
Greetings,

I'm a happy user of JOOQ, and have always admired your documentation. I'm wondering how you manage it. Is there some framework (like Jekyll) you use to generate the documentation from templates?

-Shilad

Lukas Eder

unread,
Jun 19, 2014, 2:34:03 PM6/19/14
to jooq-de...@googlegroups.com
Hi there,

Thanks for your nice words.

We have evaluated a variety of documentation frameworks that support both single-page, multi-page and PDF manual outputs, with table of contents, breadcrumbs etc. Unfortunately, most of those frameworks are very hard to customise, so we rolled our own using XSLT and XSL-FO. It was actually quite simple.

If we have time, we'll open-source that framework separately. Right now, it's not generic enough.

Cheers
Lukas


--
You received this message because you are subscribed to the Google Groups "jOOQ Developer Group" group.
To unsubscribe from this group and stop receiving emails from it, send an email to jooq-develope...@googlegroups.com.
For more options, visit https://groups.google.com/d/optout.

ss...@macalester.edu

unread,
Jun 19, 2014, 3:23:36 PM6/19/14
to jooq-de...@googlegroups.com
Thanks! I'm looking around for a documentation framework, and haven't found something that's quite right. I was worried that you would say you rolled your own :)

Lukas Eder

unread,
Jun 19, 2014, 3:39:47 PM6/19/14
to jooq-de...@googlegroups.com
Well, it's just a couple of lines of XSLT, what harm can it be to roll your own? :-)
Reply all
Reply to author
Forward
0 new messages