Bitbucket is a code hosting site with unlimited public and private repositories. We're also free for small teams!

Close
Grok Community Documentation
****************************

This is the new Grok Community Documentation. It is based on Sphinx.

Preparing the build
===================

To build the docs run::

  $ python bootstrap.py

That should generate scripts in a local ``bin/`` directory.

Then, run::

  $ ./bin/buildout

This step is only needed after download, when you try to build the
docs for the first time, or after changes to ``buildout.cfg``.

Building the docs
=================

Finally in the checkout directory run::

  $ make html

which should generate the HTML docs in a local `build/` directory.

Run::

  $ make

to see all modes available.

After changes to the sources rerun ``make``.

You can pass additional options to the sphinx-builder using
commandline arguments like this::

  $ make html SPHINXOPTS="-E -a"

for instance to clear the cache and force sphinx to generate really
all docs. The latter call is recommended when building docs to be
published publicly, as all errors and warnings will be displayed.

Recent activity

Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.