Deploying API doc

Jump to bottom Edit New page

Henry Liu edited this page Jul 26, 2017 · 1 revision

⚠ Before doing this make sure your commit-msg hook allows 'publish:' as a commit message prefix otherwise the script will fail and unable to switch you back to your own branch and you will have difficulties to switch back to your own branch from gh-pages as well.

Go to /backend/doc
run ./deploy.sh

The script will compile the API doc to html then commit and push the new html to gh-pages branch.