##// END OF EJS Templates
upstream » ipython
RSS

Clone from https://github.com/ipython/ipython.git

- Cleanup [1786], which went in with unfinished stuff by accident....
- Cleanup [1786], which went in with unfinished stuff by accident. - Revert [1785] and replace it by installing our own quitter in place of the builtin (for all py versions). This obviates the need for [1785] and gives a cleaner exit. - Fix ipdb to work with python 2.5, and update ipdb color schemes with %colors. - irunner improvements, mostly for use as a doctest runner.
vivainio - - Load All Authors

File last commit:

r102:a54f3f3a
r368:ede41cba
Show More
build_doc_instruction.txt
28 lines | 859 B | text/plain | TextLexer
/ doc / build_doc_instruction.txt
History | Annotation | Raw |Copy content |Copy permalink
How to generate IPython documentation
=====================================
The doc is written using lyx http://www.lyx.org, which is a gui for latex
documents. LyX also requires a latex installation.
The file manual_base.lyx is the template file that should be edited if you
want to do changes to the docs.
A final version is generated by running
./update_manual.py
or
ipython update_manual.py
(note that "python update_manual.py" won't work, it's an ipython script!)
The script update_manual.py will insert the current version number into the
template and also generate magic.tex, a file containing documentation for
the doc strings of the magic commands.
The script creates manual.lyx which can be opened by lyx to generate pdf or
postscript versions of the docs.
update_magic.sh and update_version.sh work too, but are slated for
deprecation.