Mercurial > evolve
view docs/README @ 5906:55b7e6523559 stable
Added tag 10.3.1 for changeset 93dc3cb68842
author | Pierre-Yves David <pierre-yves.david@octobus.net> |
---|---|
date | Sun, 25 Apr 2021 15:32:51 +0200 |
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.