view docs/README @ 5816:a1dad44fe3da

tests: remove some unnecessary config Some of these tests were originally split from a single file that had (and used) these options, and some of the tests were later created by just mindlessly copypasting the same set of options that aren't applicable to the newly written tests. Things removed by this patch: - web section from tests that don't use hg serve and don't push - phases.publish from tests that don't exchange changesets between repos - diff section from tests that don't have any diffs - defaults section that sets the date The defaults section that only adds -d '0 0' to commands should no longer be necessary because run-tests.py sets devel.default-date='0 0' since 4.3, and all command in evolve should respect this config option.
author Anton Shestakov <av6@dwimlabs.net>
date Wed, 03 Mar 2021 10:57:09 +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.