view docs/README @ 6560:abbba073aa88

topic: check for devel.randomseed existence correctly Judging by the block of code above this patch, we want to check for presence of the same config option as we then add. So in this case, it would be devel.randomseed, and not just devel.random. I couldn't find any mention of devel.random in evolve, topic or core, which makes me think it was just a typo.
author Anton Shestakov <av6@dwimlabs.net>
date Fri, 29 Sep 2023 16:36:32 -0300
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.