docs/README
author Pulkit Goyal <7895pulkit@gmail.com>
Thu, 28 Dec 2017 03:08:22 +0530
branchstable
changeset 3361 1439021d22f9
parent 2959 ef361938dfa1
permissions -rw-r--r--
tests: add a test showing wrong behaviour doing `hg prev` on orphan cset If there is an unstable changeset in the topic stack, whose parent is not a part of stack but has a successor which is part of stack, hg stack does shows them in linear order, but `hg prev` on that orphan changset says no parent on that topic. However it should update to the successor of the changeset. It will be fixed in the next patch.

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.