carnival-data / carnival

JVM property graph data unification framework
https://carnival-data.github.io/carnival/
GNU General Public License v3.0
7 stars 2 forks source link

Travis doc builder #27

Open hjwilli opened 4 years ago

hjwilli commented 4 years ago

Update travis to build dynamic docs and move them to the gh-pages branch.

augustearth commented 4 years ago

Github Pages

The Github pages site is stored in the docs directory and makes use of jekyll. See the jekyll docs for jekyll installation and usage instructions.

Prerequisites

Building

To build the documentation:

cd docs
bundle exec jekyll clean
bundle exec jekyll build

Local Jekyll Server

To run the Jekyll server locally:

bundle exec jekyll serve