docs/README
author Martin von Zweigbergk <martinvonz@google.com>
Tue, 04 Feb 2020 16:22:40 -0800
changeset 5136 bbf33d5f32ef
parent 2959 ef361938dfa1
permissions -rw-r--r--
touch: allow divergence with -A even if allowdivergence=no This is a phase-divergent update to 731b5a89a784. 1f92a6aa40d6 (evolve: add pre-check logic for content-divergence in rewriteutil.precheck(), 2019-11-04) taught `rewriteutil.precheck()` to check for divergence. It also set allowdivergence=yes in test-touch.t to silence the error. However, if one does *not* have that set, it is no longer possible to allow divergence with `hg touch -A`. This patch fixes that.

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.