This is an example showing how to generate API docs with apiDoc as part of your continuous integration build and then automatically deploying them to a public website.
Thanks apiDoc, Travis CI, and Surge for making this possible (for free) ๐.
- Pushing to master deploys a Heroku app providing the API
- Travis CI builds the project, generates API docs with apiDoc and publishes them to apidoc-example.surge.sh
To build API docs:
$ npm install
$ npm run apidocs
To deploy API docs:
$ SURGE_LOGIN=... SURGE_TOKEN=... npm run apidocs-deploy
To run the demo web app:
$ pip install
$ gunicorn app.web:app
Made with โค๏ธ by Daniel Bader โ @dbader_org โ [email protected]
Distributed under the Unlicense license. See LICENSE
for more information.