search

openstate / open-cultuur-data

The back- and front-end code that powers the Open Cultuur Data API
http://opencultuurdata.nl/
28 stars 18 forks source link

As a developer, I want to build the documentation automatically #71

Open bartdegoede opened 10 years ago

bartdegoede commented 10 years ago

The API and code documentation written in Sphinx is not built automatically. This is an undesirable situation, as there is a risk that documentation for new features is not available, and even worse, that there will be outdated information present.

Ideally, I want to build the documentation that is on http://docs.opencultuurdata.nl/ with every commit on master (i.e. when we do a release), preferably with the inclusion of a version number.

In addition to that, it would be useful to build the documentation in a separate folder on every commit on a branch, in order to make the life the one testing easier.

My guess is that webhooks could be a suitable solution for that.

breyten commented 10 years ago

I guess in coordination with something like this? https://github.com/razius/github-webhook-handler