- Jul 25, 2017
-
-
Christoph Groth authored
I assume that most people encounter the tutorial example scripts by reading the documentation, and not by viewing the tutorial subdirectory of a checked-out Kwant source. That's the motivation for moving all the manipulations of tutorial scripts from setup.py to doc/Makefile. Previously, a successful 'make html' would require a preceding execution of 'setup.py build_tut'. Now, a simple 'make html' is enough. While at it, I reorganized where the example scripts and their outputs are stored. Everything is now in 'doc/source/code' with its three subdirectories 'download' (to be shown to readers), 'include' (with include markers), and 'figure' (figure generation & figures). This organization is clearer and also makes the generation of figures separate from the tutorial.
-
Christoph Groth authored
The basic idea remains the same, but should work much better now. The difference is that images/example.py.diff is now a patch with complete context and becomes the authoritative source for both the visible flavor of an example as well as for its figure-generating variant. Both tutorial/example.py and images/example.py are extracted from this file by 'make html'. Thanks to the complete context the diffs are quite readable and may be modified directly. Alternatively, one may also modify the generated scripts. When tutorial/example.py has been modified, it will be patched and saved as images/example.py. The patching is done using the tool 'wiggle' that works much better than 'patch'. If a conflict occurs, conflict markers are added to the output file and its dated back to the dawn of time (i.e. 1970) in order to mark the conflicts as not yet resolved. After resolving, 'make html' is simply run again. Upon a successful execution of the figure-generating script the diff gets recreated automatically, 'generate-diffs' no longer exists.
-
- May 05, 2016
-
-
Joseph Weston authored
this fixes #35
-
- Nov 26, 2015
-
-
Christoph Groth authored
-
- Nov 05, 2015
-
-
Joseph Weston authored
Running 2to3 removed a line in the graphene.py tutorial script, which broke the diff file. We manually update the diff file to fix this.
-
- Sep 08, 2013
-
-
- Sep 06, 2013
-
-
- Aug 29, 2013
-
-
Christoph Groth authored
-
- Aug 24, 2013
-
-
- Jun 07, 2013
-
-
Christoph Groth authored
-
- Jun 04, 2013
-
-
- Apr 13, 2013
-
-
Christoph Groth authored
-
- Mar 18, 2013
-
-
- Mar 14, 2013
-
-
- Feb 14, 2013
-
-
Christoph Groth authored
-
- Nov 28, 2012
-
-
Christoph Groth authored
-
- Nov 22, 2012
-
-
Christoph Groth authored
-
Christoph Groth authored
-
- Aug 18, 2012
-
-
- Nov 18, 2012
-
-
- Nov 17, 2012
-
-
Christoph Groth authored
-