view docs/README @ 5776:453ba695c3d4

tests: add test for in-memory evolve, not actually in-memory yet The next patch will make `hg evolve` use in-memory merge. This patch adds a test case for that. I'm adding it before the implementation so it's easy to see what the behavior change is.
author Martin von Zweigbergk <martinvonz@google.com>
date Thu, 01 Oct 2020 12:34:36 -0700
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.