Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP

the site running at pinaxproject.com

branch: dev

This branch is 0 commits ahead and 9 commits behind master

Fetching latest commit…

Cannot retrieve the latest commit at this time

README.rst

Setting up documentation

Create a directory somewhere on your filesystem which will be the DOCS_ROOT. Set the setting DOCS_ROOT to its path in your local_settings.py.

To setup the documentation run the following commands:

cd $DOCS_ROOT # fill in with yours
virtualenv --no-site-packages env
env/bin/pip install Sphinx==1.0.5
git clone -b master git@github.com:pinax/pinax.git pinax-master
git clone -b 0.7.X git@github.com:pinax/pinax.git pinax-0.7.X
env/bin/sphinx-build -b pickle -aE pinax-0.7.X/docs/ output-0.7.X
env/bin/sphinx-build -b pickle -aE pinax-master/docs/ output-master

This will be sufficient to run the documentation locally.

To update the docs to the latest version run:

cd $DOCS_ROOT # fill in with yours
(cd pinax-0.7.X ; git pull)
(cd pinax-master ; git pull)
env/bin/sphinx-build -b pickle -aE pinax-0.7.X/docs/ output-0.7.X
env/bin/sphinx-build -b pickle -aE pinax-master/docs/ output-master
Something went wrong with that request. Please try again.