docs/README
author Pierre-Yves David <pierre-yves.david@octobus.net>
Thu, 21 Dec 2017 02:01:58 +0100
changeset 3340 fd90e73bf79a
parent 2959 ef361938dfa1
permissions -rw-r--r--
caches: factorise the cache warming check The old conditional was duplicated and hard to read. We factorise everything into the `utility` module.

Doc is generated with sphinx.

You can generate the doc with:

```
make
```

# Tutorials

For updating the tutorials, you need to have the docgraph extension installed
(https://pypi.python.org/pypi/hg-docgraph).

Then run the test-topic-tutorial.t and test-tutorial.t to update the output if
needed.

You'll need the dot binary (likely installed by the graphviz package in your
package manager) in order to have graphviz graphs rendered in the html output.

Simply run make in the docs directory should takes care of the conversion of
the tutorial .t files into .rst files. Then sphinx should do the rest of the
jobs by rendering graphviz graphs.