docs/README
changeset 2959 ef361938dfa1
parent 161 4e3f25ba5401
equal deleted inserted replaced
2958:1cb715257130 2959:ef361938dfa1
     1 doc generated with sphinx. tutorial exported using sphinxedhg
     1 Doc is generated with sphinx.
     2 
     2 
     3 http://hg.piranha.org.ua/sphinxedhg/
     3 You can generate the doc with:
       
     4 
       
     5 ```
       
     6 make
       
     7 ```
       
     8 
       
     9 # Tutorials
       
    10 
       
    11 For updating the tutorials, you need to have the docgraph extension installed
       
    12 (https://pypi.python.org/pypi/hg-docgraph).
       
    13 
       
    14 Then run the test-topic-tutorial.t and test-tutorial.t to update the output if
       
    15 needed.
       
    16 
       
    17 You'll need the dot binary (likely installed by the graphviz package in your
       
    18 package manager) in order to have graphviz graphs rendered in the html output.
       
    19 
       
    20 Simply run make in the docs directory should takes care of the conversion of
       
    21 the tutorial .t files into .rst files. Then sphinx should do the rest of the
       
    22 jobs by rendering graphviz graphs.