Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP

This branch is 2638 commits ahead, 293 commits behind pinax:master

Fetching latest commit…

Cannot retrieve the latest commit at this time

..
Failed to load latest commit information.
_images
external
releases
Makefile
README
build_docs.sh
buildout.txt
conf.py
contributing.txt
customization.txt
dependencies.txt
deployment.txt
external_apps.txt
faq.txt
groups.txt
index.txt
install.txt
intro.txt
media.txt
pil.txt
settings.txt
tabs.txt

README

Building documentation
======================

To build the documentation (from root of source tree)::

    cd docs/
    bash build_docs.sh

This will create ``external/repos`` where it will checkout external
repositories. It will create symlinks in ``external/`` pointing to the docs
directories. This allows Sphinx to properly reference external documentation.

Running ``build_docs.sh`` more than once is okay. It cleans up any previous
runs.

@@@ Don't do full checkouts on each run of ``build_docs.sh``.


Building documentation on pinaxproject.com
==========================================

This section only applies to individuals wanting to build documentation on
pinaxproject.com. To build the documentation (assuming working directory is
``/home/pinax``)::

    cd docs_build/pinax-master
    git pull
    cd docs/
    bash build_docs.sh

While ``build_docs.sh`` is running the online documentation goes down. Ideally
we build in support to show a page indicating the rebuild while running.
Something went wrong with that request. Please try again.