labra / ShExcala

ShEx expressions in Scala
http://labra.github.io/ShExcala/
MIT License
11 stars 3 forks source link

Automate documentation generation #18

Open labra opened 9 years ago

labra commented 9 years ago

Add a docs folder where I can include some documentation and examples.

The tut approach that i found in cats looks quite interesting: https://github.com/tpolecat/tut

ghost commented 9 years ago

@labra I have a task with Cats to have travis automatically push the docs - https://github.com/non/cats/issues/155

I have add a few extra thoughts that might/should be added to this as well, so you may want to track that issue. Main points revolve around versioning of docs, examples, scaladoc w.r.t code releases