docs

README

sqlr documentation

This directory contains the restructured text source for the detailed package documentation. This documentation is built using the Sphinx Document Generator.

You can view the generated documentation at https://jjeffery.github.io/sqlr.

To build the documentation:

1. Clone the sqlr repository to an arbitrary location. The example uses ~/docs. If you are using your own fork you will have to adjust the location in the git clone commannd.

mkdir -p ~/docs
cd ~/docs
git clone git@github.com:jjeffery/sqlr
cd sqlr
git checkout gh-pages
git symbolic-ref HEAD refs/heads/gh-pages  # auto-switches branches to gh-pages

1. Confirm that you are are on the gh-pages branch.

git branch

1. Create an environment variable SQLR_GHPAGES that points to the directory you have just created. The Makefile uses this environment variable to find the location to put the generated HTML.

echo "export SQLR_GHPAGES=$PWD" >> ~/.bash_profile
. ~/.bash_profile
echo $SQLR_GHPAGES

1. Change directory to the docs source directory and run the document generator.

cd $GOPATH/src/github.com/jjeffery/sqlr/docs
make html

1. The generated documentation is now present in the ~/docs/sqlr directory. Commit to git and push, and the documentation is ready to view.

cd ~/docs/sqlr
git add -A .
git commit -m "update documentation"
git push

Documentation

Overview

Directory docs contains detailed documentation.