docs/makefile
author Greg Ward <greg@gerg.ca>
Thu, 05 Jun 2014 22:11:04 -0400
changeset 978 8328337d23b2
parent 765 015cd9d3bfdd
child 2824 d0e3a8e0b62c
permissions -rw-r--r--
docs: add new user guide This has also been reviewed to death on evolve-testers. There are still a couple of short sections to write (clearly marked "TODO"), and one example to add. But (if I may be so bold) this is a gigantic improvement over the current docs, so it really should get merged. Incidentally, the figures are all SVG files created with Inkscape. They're not perfect, but they're pretty nice. Anyone who knows a better way to create technical diagrams is welcome to contribute. One wart: there's a test script that accompanies the document and largely duplicates it, but I haven't unified them. I've been concentrating on writing the best possible content, not on fiddling with tools. I suspect that unifying them will be non-trivial, but definitely worth doing.
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
765
015cd9d3bfdd doc: smarter make file
Pierre-Yves David <pierre-yves.david@fb.com>
parents: 558
diff changeset
     2
all: tutorials/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
558
11c5f734d64e docs: fix makefile
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents: 557
diff changeset
     8
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
     9
	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
    10
41688ca951e7 doc: add a logo
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents: 242
diff changeset
    11