search

brightcove / valerie

First class validation library for the JVM
Other
3 stars 0 forks source link

New Documentation #36

Closed mwhipple closed 5 years ago

mwhipple commented 7 years ago

push to gh-pages as part of release?

mwhipple commented 7 years ago

example using https://github.com/ajoberstar/gradle-git: https://github.com/johnrengelman/shadow/blob/master/gradle/ghPages.gradle

mwhipple commented 6 years ago

I'm planning on using Sphinx with Breathe for the documentation for this project. I've had good experiences with Sphinx in the past and I'm presently using the combination of those tools on a hobby project and it comes together nicely. Breathe (by way of Doxygen) has nice Java support which makes it a good fit for this project compared to AsciiDoctor which is more tailored for slicker platforms.