Show More
@@ -0,0 +1,28 b'' | |||
|
1 | How to generate IPython documentation | |
|
2 | ===================================== | |
|
3 | ||
|
4 | The doc is written using lyx http://www.lyx.org, which is a gui for latex | |
|
5 | documents. LyX also requires a latex installation. | |
|
6 | ||
|
7 | The file manual_base.lyx is the template file that should be edited if you | |
|
8 | want to do changes to the docs. | |
|
9 | ||
|
10 | A final version is generated by running | |
|
11 | ||
|
12 | ./update_manual.py | |
|
13 | ||
|
14 | or | |
|
15 | ||
|
16 | ipython update_manual.py | |
|
17 | ||
|
18 | (note that "python update_manual.py" won't work, it's an ipython script!) | |
|
19 | ||
|
20 | The script update_manual.py will insert the current version number into the | |
|
21 | template and also generate magic.tex, a file containing documentation for | |
|
22 | the doc strings of the magic commands. | |
|
23 | ||
|
24 | The script creates manual.lyx which can be opened by lyx to generate pdf or | |
|
25 | postscript versions of the docs. | |
|
26 | ||
|
27 | update_magic.sh and update_version.sh work too, but are slated for | |
|
28 | deprecation. |
@@ -10,6 +10,11 b'' | |||
|
10 | 10 | multiline command strings in !system or %magic commands. Thanks to |
|
11 | 11 | Jerry McRae for suggestions. |
|
12 | 12 | |
|
13 | * doc/build_doc_instructions.txt added. Documentation on how to use | |
|
14 | doc/update_manual.py, added yesterday. Both files contributed by | |
|
15 | Jörgen Stenarson <jorgen.stenarson@bostream.nu>. This slates | |
|
16 | doc/*.sh for deprecation at a later date. | |
|
17 | ||
|
13 | 18 | 2006-01-12 Fernando Perez <Fernando.Perez@colorado.edu> |
|
14 | 19 | |
|
15 | 20 | * IPython/ipstruct.py (Struct): Rename IPython.Struct to |
@@ -1,13 +1,13 b'' | |||
|
1 | #!/usr/bin/env ipython | |
|
1 | 2 | """ Must be launched via ipython not normal python |
|
2 | 3 | |
|
3 | in ipython prompt do | |
|
4 | Run by: | |
|
4 | 5 | |
|
5 |
|
|
|
6 | ipython update_manual.py | |
|
6 | 7 | """ |
|
7 | 8 | |
|
8 | 9 | import sys,IPython,re |
|
9 | 10 | |
|
10 | ||
|
11 | 11 | fil=open("magic.tex","w") |
|
12 | 12 | oldout=sys.stdout |
|
13 | 13 | sys.stdout=fil |
@@ -23,4 +23,6 b' manualtext=re.sub("__version__",IPython.__version__,txt)' | |||
|
23 | 23 | fil=open("manual.lyx","w") |
|
24 | 24 | fil.write(manualtext) |
|
25 | 25 | fil.close() |
|
26 |
print "Manual (magic.tex, manual.lyx) succesfully updated |
|
|
26 | print "Manual (magic.tex, manual.lyx) succesfully updated, exiting..." | |
|
27 | import os | |
|
28 | os.abort() |
General Comments 0
You need to be logged in to leave comments.
Login now