docs/README
author Sushil khanchi <sushilkhanchi97@gmail.com>
Thu, 17 Jan 2019 16:20:35 +0530
changeset 4343 11b726506204
parent 2959 ef361938dfa1
permissions -rw-r--r--
evolve: add test which shows orphan-merge resolution can result to crash It happens when there are still some revisions to evolve after evoluiton of a orphan-merge. And the reason behind crash is that `lastsolved` is not being updated and contain a wrong value which is now hidden. Next patch will fix this problem.

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.