The pages are published using the Read The Docs online service.
Any changed pushed to master is automatically published online.
There is paver file to help running a few local tasks.
To initiate the dev environment:
./brink.sh deps or pip install -r docs/requirements.txt
To generate the page on your local system:
./brink.sh generate or sphinx-build -b html -j 2 -n -W docs/ build-geck/html/
To view the local result:
firefox build/html/index.html
To run a few tests:
./brink.sh test
If you are currently onboarding with the Chevah Project, making improvements to the GECK is a good starting point.
Below is a guide that you can follow to make changes to this repo:
Create a new branch and check out to that branch so that you are working on your own branch and not the master branch.
git checkout -b geck-improvements with
geck-improvements as an example branch name.
If there is a GitHub issue involved, add the ID at the beginning of the branch name:
1234-geck-improvements
Once all changes are made, git push your changes out to your git branch (not the master branch) and create the first Pull Request.