view docs/README @ 5720:ceaa85c47973 stable

tests: update exit code for command errors CORE-TEST-OUTPUT-UPDATE: 9c9e0b4b2ca7
author Anton Shestakov <av6@dwimlabs.net>
date Wed, 20 Jan 2021 14:47:22 +0800
parents ef361938dfa1
children
line wrap: on
line source

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.