view docs/README @ 3519:2823c82ad8a4

obslog: add the operation to the Obslog output

The operation is helpful when debugging a case where we don't know how we
ended up in this case while effect-flag are useful to understand what semantic
changes happens to a changeset.

Add the operation when displaying an obs-marker in the following form:

    `rewritten as X using amend`

The other proposal is interesting but seems harder to internationalize and
might requires update each time we introduce new operation:

    `Amended as X`

Let's use the first proposal right now.

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.