Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Open
bartdegoede opened this issue Nov 24, 2014 · 1 comment
Open

Comments

@bartdegoede
Copy link
Contributor

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
Copy link
Member

breyten commented Nov 24, 2014

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants