docs/README
author Pierre-Yves David <pierre-yves.david@octobus.net>
Sat, 09 Dec 2017 17:14:53 +0100
changeset 3244 d5a7edd5d008
parent 2959 ef361938dfa1
permissions -rw-r--r--
stablerange: update the filename to avoid cache confusion The schema validation seems to not work as well as intended, we update the file name to make sure there will be no confusion.

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.