view docs/README @ 5853:13b108c3782e stable

evolve: use cl.tiprev() instead of len(cl) - 1 We have this nice method of revlogs that will make code slightly easier to read, why not use it. Revlogs also have a .tip() method to return tip as node hash, but only in 5.3+.
author Anton Shestakov <av6@dwimlabs.net>
date Tue, 16 Mar 2021 21:25:11 +0800
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.