docs/README
author Anton Shestakov <av6@dwimlabs.net>
Mon, 11 Nov 2019 02:33:54 +0700
branchstable
changeset 4934 1765fd925fc1
parent 2959 ef361938dfa1
permissions -rw-r--r--
docs: revision numbers are technically stable From `hg help glossary`: "Note that the revision number may be different in each clone of a repository." But cloning the same repo multiple times yields the same result, and that shows that revision numbers are stable.

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.