docs/README
author Anton Shestakov <av6@dwimlabs.net>
Thu, 12 Sep 2019 14:42:38 +0700
changeset 5220 76dc63c4131c
parent 2959 ef361938dfa1
permissions -rw-r--r--
stack: use self._revs in stack.heads() No code cares about the ordering of the heads anyway, so let's use the unordered property that doesn't need to be sliced (because it doesn't include base).

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.