-
- Downloads
improve the tutorial script and image buiding machinery
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.
Showing
- .gitignore 1 addition, 0 deletions.gitignore
- INSTALL.rst 18 additions, 0 deletionsINSTALL.rst
- doc/Makefile 47 additions, 16 deletionsdoc/Makefile
- doc/source/images/ab_ring.py.diff 92 additions, 6 deletionsdoc/source/images/ab_ring.py.diff
- doc/source/images/band_structure.py.diff 37 additions, 4 deletionsdoc/source/images/band_structure.py.diff
- doc/source/images/closed_system.py.diff 96 additions, 5 deletionsdoc/source/images/closed_system.py.diff
- doc/source/images/discretize.py.diff 164 additions, 9 deletionsdoc/source/images/discretize.py.diff
- doc/source/images/faq.py.diff 309 additions, 24 deletionsdoc/source/images/faq.py.diff
- doc/source/images/generate-diffs.sh 0 additions, 16 deletionsdoc/source/images/generate-diffs.sh
- doc/source/images/graphene.py.diff 135 additions, 6 deletionsdoc/source/images/graphene.py.diff
- doc/source/images/kernel_polynomial_method.py.diff 152 additions, 9 deletionsdoc/source/images/kernel_polynomial_method.py.diff
- doc/source/images/magnetic_texture.py.diff 156 additions, 13 deletionsdoc/source/images/magnetic_texture.py.diff
- doc/source/images/plot_graphene.py.diff 62 additions, 8 deletionsdoc/source/images/plot_graphene.py.diff
- doc/source/images/plot_qahe.py.diff 59 additions, 4 deletionsdoc/source/images/plot_qahe.py.diff
- doc/source/images/plot_zincblende.py.diff 39 additions, 5 deletionsdoc/source/images/plot_zincblende.py.diff
- doc/source/images/quantum_well.py.diff 64 additions, 4 deletionsdoc/source/images/quantum_well.py.diff
- doc/source/images/quantum_wire.py.diff 101 additions, 5 deletionsdoc/source/images/quantum_wire.py.diff
- doc/source/images/spin_orbit.py.diff 80 additions, 4 deletionsdoc/source/images/spin_orbit.py.diff
- doc/source/images/superconductor.py.diff 96 additions, 6 deletionsdoc/source/images/superconductor.py.diff
- doc/source/tutorial/README 0 additions, 11 deletionsdoc/source/tutorial/README
Loading
Please register or sign in to comment