docs/README
author Pulkit Goyal <7895pulkit@gmail.com>
Tue, 09 Jan 2018 15:39:47 +0530
changeset 3388 be41e4740a25
parent 2959 ef361938dfa1
permissions -rw-r--r--
evolve: use phases.new-commit config to retain phase information (issue5720) Since the previous patches replaced the use of graftstate with evolvestate and we don't graft anymore on evolve --continue, we have now the capability to fix underlying bugs. This patch makes sure we use the phases.new-commit config to make a new commit of the same phase as that of the predecessor. Tests added in the previous patch shows the bug being fixed.

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.