docs/makefile
author Boris Feld <boris.feld@octobus.net>
Tue, 29 Aug 2017 16:42:40 +0200
changeset 2950 1b4c92621e23
parent 2824 d0e3a8e0b62c
child 2960 1a4f26eec0af
permissions -rw-r--r--
doc: integrate graphviz graphs in tutorials Use the mercurial-graphviz extension (https://bitbucket.org/octobus/mercurial_graphviz) in tutorials in order to have some dot graphs in the tutorials .t files. In order to run the tests, export the GRAPHVIZ_EXTENSION variable which points to your copy of the extension. Please be aware that pygraphviz should be installed in your environment. That should be sufficient for generating dot graphs in text format. Then generate the doc as usual, the sphinx-graphviz extension (http://www .sphinx-doc.org/en/stable/ext/graphviz.html) has been added and it should handle the generation of the graphs. Please be aware that you need the dot binary installed in your system. Please refer to the extension documentation for more configuration.
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
233
9e153a9101c3 [doc] add a simple make file
Pierre-Yves.David@ens-lyon.org
parents:
diff changeset
     1
2824
d0e3a8e0b62c docs: move the topic tutorial in the documentation
Boris Feld <boris.feld@octobus.net>
parents: 765
diff changeset
     2
all: tutorials/tutorial.rst tutorials/topic-tutorial.rst static/logo-evolve.ico
242
1fc4299ca8e2 [doc] change doc generation directory
Pierre-Yves.David@ens-lyon.org
parents: 235
diff changeset
     3
	sphinx-build . ../html/
233
9e153a9101c3 [doc] add a simple make file
Pierre-Yves.David@ens-lyon.org
parents:
diff changeset
     4
765
015cd9d3bfdd doc: smarter make file
Pierre-Yves David <pierre-yves.david@fb.com>
parents: 558
diff changeset
     5
tutorials/tutorial.rst: tutorials/tutorial.t
235
8469ccb9550f [doc] add `.t` to `.rst` converteur
Pierre-Yves.David@ens-lyon.org
parents: 233
diff changeset
     6
	python test2rst.py tutorials/
557
41688ca951e7 doc: add a logo
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents: 242
diff changeset
     7
2824
d0e3a8e0b62c docs: move the topic tutorial in the documentation
Boris Feld <boris.feld@octobus.net>
parents: 765
diff changeset
     8
tutorials/topic-tutorial.rst: tutorials/topic-tutorial.t
d0e3a8e0b62c docs: move the topic tutorial in the documentation
Boris Feld <boris.feld@octobus.net>
parents: 765
diff changeset
     9
	python test2rst.py tutorials/
d0e3a8e0b62c docs: move the topic tutorial in the documentation
Boris Feld <boris.feld@octobus.net>
parents: 765
diff changeset
    10
558
11c5f734d64e docs: fix makefile
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents: 557
diff changeset
    11
static/logo-evolve.ico: static/logo-evolve.svg
557
41688ca951e7 doc: add a logo
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents: 242
diff changeset
    12
	convert -resize 36x36 static/logo-evolve.svg static/logo-evolve.ico
41688ca951e7 doc: add a logo
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents: 242
diff changeset
    13
41688ca951e7 doc: add a logo
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents: 242
diff changeset
    14