pinax / docs /

Filename Size Date modified Message
2.2 KB
1003 B
1.4 KB
5.6 KB
4.7 KB
2.0 KB
3.6 KB
2.4 KB
526 B
965 B
8.6 KB
1.7 KB
2.5 KB
4.6 KB
Building documentation

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

    cd docs/

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 ```` more than once is okay. It cleans up any previous

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

Building documentation on

This section only applies to individuals wanting to build documentation on To build the documentation (assuming working directory is

    cd docs_build/pinax-master
    git pull
    cd docs/

While ```` is running the online documentation goes down. Ideally
we build in support to show a page indicating the rebuild while running.