[IPython-dev] IPython documentation

Brian Granger ellisonbg.net@gmail....
Thu Jun 12 12:03:39 CDT 2008


>
> Actually, with single file, search is just ctrl + F away ;-)
>
> Additional advantage of a single big file is that it's easy to print
> (both the source and built documentation), if need be (e.g. if you
> don't happen have the pdf handy). The .rst document is usable as a
> documentation as such, on systems that don't have viewers for other
> file systems.
>
> It's true, though, that Sphinx is optimized for multiple source files,
> so either way is fine.

The main reason that I did this is that the size of the single file
was becoming a bit crazy with all of the new parallel computing docs
merged in.  I really want the docs to be easy for us devs to maintain
and having multiple files really help a lot.

Brian


> --
> Ville M. Vainio - vivainio.googlepages.com
> blog=360.yahoo.com/villevainio - g[mail | talk]='vivainio'
>


More information about the IPython-dev mailing list