view docs/README @ 5784:43a5371fa669

divergence-resolution: add support and doc for a special case in divergence Changes in troubles-handling.rst explains the special case in details and also speak about what is the default behavior and how to change it.
author Sushil khanchi <sushilkhanchi97@gmail.com>
date Thu, 18 Feb 2021 23:37:41 +0530
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.