docs/README
author Pierre-Yves David <pierre-yves.david@octobus.net>
Tue, 10 Oct 2017 16:12:44 +0200
branchstable
changeset 3049 02c4a0b550ab
parent 2959 ef361938dfa1
permissions -rw-r--r--
obsfate: update test The obsfate templatekw and the obsfateprinter behavior was different when displaying or not the current user in obsfate users. Update the test to makes the behavior fix more visible.
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
2959
ef361938dfa1 doc: integrate graphviz graphs in tutorials
Boris Feld <boris.feld@octobus.net>
parents: 161
diff changeset
     1
Doc is generated with sphinx.
ef361938dfa1 doc: integrate graphviz graphs in tutorials
Boris Feld <boris.feld@octobus.net>
parents: 161
diff changeset
     2
ef361938dfa1 doc: integrate graphviz graphs in tutorials
Boris Feld <boris.feld@octobus.net>
parents: 161
diff changeset
     3
You can generate the doc with:
ef361938dfa1 doc: integrate graphviz graphs in tutorials
Boris Feld <boris.feld@octobus.net>
parents: 161
diff changeset
     4
ef361938dfa1 doc: integrate graphviz graphs in tutorials
Boris Feld <boris.feld@octobus.net>
parents: 161
diff changeset
     5
```
ef361938dfa1 doc: integrate graphviz graphs in tutorials
Boris Feld <boris.feld@octobus.net>
parents: 161
diff changeset
     6
make
ef361938dfa1 doc: integrate graphviz graphs in tutorials
Boris Feld <boris.feld@octobus.net>
parents: 161
diff changeset
     7
```
ef361938dfa1 doc: integrate graphviz graphs in tutorials
Boris Feld <boris.feld@octobus.net>
parents: 161
diff changeset
     8
ef361938dfa1 doc: integrate graphviz graphs in tutorials
Boris Feld <boris.feld@octobus.net>
parents: 161
diff changeset
     9
# Tutorials
161
4e3f25ba5401 More doc and index with sphynx
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents:
diff changeset
    10
2959
ef361938dfa1 doc: integrate graphviz graphs in tutorials
Boris Feld <boris.feld@octobus.net>
parents: 161
diff changeset
    11
For updating the tutorials, you need to have the docgraph extension installed
ef361938dfa1 doc: integrate graphviz graphs in tutorials
Boris Feld <boris.feld@octobus.net>
parents: 161
diff changeset
    12
(https://pypi.python.org/pypi/hg-docgraph).
ef361938dfa1 doc: integrate graphviz graphs in tutorials
Boris Feld <boris.feld@octobus.net>
parents: 161
diff changeset
    13
ef361938dfa1 doc: integrate graphviz graphs in tutorials
Boris Feld <boris.feld@octobus.net>
parents: 161
diff changeset
    14
Then run the test-topic-tutorial.t and test-tutorial.t to update the output if
ef361938dfa1 doc: integrate graphviz graphs in tutorials
Boris Feld <boris.feld@octobus.net>
parents: 161
diff changeset
    15
needed.
ef361938dfa1 doc: integrate graphviz graphs in tutorials
Boris Feld <boris.feld@octobus.net>
parents: 161
diff changeset
    16
ef361938dfa1 doc: integrate graphviz graphs in tutorials
Boris Feld <boris.feld@octobus.net>
parents: 161
diff changeset
    17
You'll need the dot binary (likely installed by the graphviz package in your
ef361938dfa1 doc: integrate graphviz graphs in tutorials
Boris Feld <boris.feld@octobus.net>
parents: 161
diff changeset
    18
package manager) in order to have graphviz graphs rendered in the html output.
ef361938dfa1 doc: integrate graphviz graphs in tutorials
Boris Feld <boris.feld@octobus.net>
parents: 161
diff changeset
    19
ef361938dfa1 doc: integrate graphviz graphs in tutorials
Boris Feld <boris.feld@octobus.net>
parents: 161
diff changeset
    20
Simply run make in the docs directory should takes care of the conversion of
ef361938dfa1 doc: integrate graphviz graphs in tutorials
Boris Feld <boris.feld@octobus.net>
parents: 161
diff changeset
    21
the tutorial .t files into .rst files. Then sphinx should do the rest of the
ef361938dfa1 doc: integrate graphviz graphs in tutorials
Boris Feld <boris.feld@octobus.net>
parents: 161
diff changeset
    22
jobs by rendering graphviz graphs.