monome / norns

norns is many sound instruments.
http://monome.org
GNU General Public License v3.0
633 stars 147 forks source link

consider generating API docs as part of the build #590

Closed pq closed 6 years ago

pq commented 6 years ago

currently the docs are getting generated manually and are unsurprisingly laggy.

image

(see #589.)

it would be great to automate generation (for lua and sc).

i'm not sure how exactly this would work with how we're currently hosting docs but i think we could use gh-pages without too much hassle.

tehn commented 6 years ago

current the API docs are not hosted on the web. i think it'd be sensible to investigate gh-pages as an update to monome.org requires a manual trigger as well.

agreed that travis automation would be great for this!

tehn commented 6 years ago

re: hosting docs = https://github.com/monome/norns/issues/484

pq commented 6 years ago

initial implementation of deploy to gh-pages complete. 🎉

https://monome.github.io/norns/doc/

still todo: