Mercurial > evolve
view docs/README @ 5580:cc0f46025c7f
evolve: remove trailing white spaces
author | Sushil khanchi <sushilkhanchi97@gmail.com> |
---|---|
date | Fri, 21 Aug 2020 18:05:37 +0530 |
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.