Mercurial > evolve
view docs/README @ 5422:39cd95b6f566
readme: shorter path to byteify-strings.py and not editing per-user config
Long path inside indented block usually means horizontal scrollbar.
author | Anton Shestakov <av6@dwimlabs.net> |
---|---|
date | Fri, 17 Jul 2020 09:52:37 +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.