view docs/README @ 6030:30cde40dcd17

topic: drop the old way to handle topic changes on amends

This seems to be a very old way of making sure topics can be cleared by
amending. See 565f057bdc08 and ec28b6c3414a, both of which are from 2015
(around the time of hg 3.6).

For the current take on handling amending in topic extension see 6275808e89ef.

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.