view docs/README @ 6553:50f55918b417

pick: update commit message hashes like other rewrite commands Maybe it would be better to use `evolvecmd._relocate()`, which does this already, but I don't know what subtle behavior changes that would trigger. Also, there are other commands (like `metaedit`) that use `rewriteutil.rewrite` instead, and so don't refresh their hashes either. We probably need a better way to track all of this, but I'm not sure how.
author Matt Harbison <matt_harbison@yahoo.com>
date Tue, 12 Sep 2023 11:45:49 -0400
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.