Skip to content

mraak/pinaxproject.com

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

331 Commits
 
 
 
 
 
 

Repository files navigation

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

About

the site running at pinaxproject.com

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages

  • Python 98.4%
  • JavaScript 1.6%