##// END OF EJS Templates
* IPython/Extensions/ipipe.py: Rename XAttr to AttributeDetail...
* IPython/Extensions/ipipe.py: Rename XAttr to AttributeDetail and make it iterable (iterating over the attribute itself). Add two new magic strings for __xattrs__(): If the string starts with "-", the attribute will not be displayed in ibrowse's detail view (but it can still be iterated over). This makes it possible to add attributes that are large lists or generator methods to the detail view. Replace magic attribute names and _attrname() and _getattr() with "descriptors": For each type of magic attribute name there's a subclass of Descriptor: None -> SelfDescriptor(); "foo" -> AttributeDescriptor("foo"); "foo()" -> MethodDescriptor("foo"); "-foo" -> IterAttributeDescriptor("foo"); "-foo()" -> IterMethodDescriptor("foo"); foo() -> FunctionDescriptor(foo). Magic strings returned from __xattrs__() are still supported. * IPython/Extensions/ibrowse.py: If fetching the next row from the input fails in ibrowse.fetch(), the exception object is added as the last item and item fetching is canceled. This prevents ibrowse from aborting if e.g. a generator throws an exception midway through execution. * IPython/Extensions/ipipe.py: Turn ifile's properties mimetype and encoding into methods.

File last commit:

r102:a54f3f3a
r355:9c312a73
Show More
build_doc_instruction.txt
28 lines | 859 B | text/plain | TextLexer
/ doc / build_doc_instruction.txt
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.