diff --git a/doc/build_doc_instruction.txt b/doc/build_doc_instruction.txt deleted file mode 100644 index b546509..0000000 --- a/doc/build_doc_instruction.txt +++ /dev/null @@ -1,28 +0,0 @@ -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. diff --git a/doc/update_magic.sh b/doc/update_magic.sh deleted file mode 100755 index 71098a8..0000000 --- a/doc/update_magic.sh +++ /dev/null @@ -1,2 +0,0 @@ -#!/bin/sh -ipython --magic_docstrings > magic.tex \ No newline at end of file diff --git a/doc/update_manual.py b/doc/update_manual.py deleted file mode 100644 index 2ab5e64..0000000 --- a/doc/update_manual.py +++ /dev/null @@ -1,28 +0,0 @@ -#!/usr/bin/env ipython -""" Must be launched via ipython not normal python - -Run by: - - ipython update_manual.py -""" - -import sys,IPython,re - -fil=open("magic.tex","w") -oldout=sys.stdout -sys.stdout=fil -_ip.magic("magic -latex") -sys.stdout=oldout -fil.close() - -fil=open("manual_base.lyx") -txt=fil.read() -fil.close() - -manualtext=re.sub("__version__",IPython.__version__,txt) -fil=open("manual.lyx","w") -fil.write(manualtext) -fil.close() -print "Manual (magic.tex, manual.lyx) succesfully updated, exiting..." -import os -os.abort()