Source

pinax / docs /

Filename Size Date modified Message
..
_images
external
releases
2.2 KB
1003 B
1.9 KB
5.9 KB
5.5 KB
4.9 KB
5.2 KB
2.0 KB
4.1 KB
2.4 KB
526 B
2.8 KB
5.9 KB
935 B
4.0 KB
1.6 KB
3.2 KB
834 B
9.2 KB
4.0 KB
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.