- 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.
-
- Jul 20, 2017
-
-
Christoph Groth authored
-
Christoph Groth authored
lowercase FAQ.rst, FAQ.py, etc., give meaningful names to labels, and stop building an user-visible tutorial/faq.py
-
Joseph Weston authored
Apply pep8 fixes and refactor some sections to be more idiomatic (e.g. avoiding triple nested loops). Also some minor reorganisation of the sections to give the text a better flow.
-
-