docs/README
author Pierre-Yves David <pierre-yves.david@octobus.net>
Thu, 19 Apr 2018 16:08:01 +0200
changeset 3696 39231f02902b
parent 2959 ef361938dfa1
permissions -rw-r--r--
compat: drop compatibility wrapper for "relevantmarkers" We no longer support version without the logic we have been adding.

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.