[IPython-dev] sphinx documentation for ipython1
fperez.net at gmail.com
Sun Mar 23 06:49:44 EDT 2008
On Sat, Mar 22, 2008 at 8:41 PM, Ondrej Certik <ondrej at certik.cz> wrote:
> I committed a nice sphinx based documentation to the ipython1-doc
> branch. You can try it out for example by:
> $ bzr branch http://bazaar.launchpad.net/~ipython/ipython/ipython1-doc
> $ cd ipython1-doc/docs
> $ make html
> $ epiphany _build/html/index.html
> (Use your favourite browser instead of epiphany).
Sweet! The built-in search (jscript tricks, I presume) is absolutely
phenomenal. I'm updating the cron job to pull from this so everyone
has access to these docs, we should merge this very soon into the dev
> The "make html" will download Sphinx from the net (so you need to have
> an internet connection) and puts it into the sphinx directory in the
> current dir. Subsequent invocations of "make html" will reuse it. I
> suggest you to browse the history of my commits to see what exact
> changes I had to do in order to make all this work.
> The changes broke the pdf generation - this would have to be fixed,
> but I suggest to get at least the html documentation right and
> polished, only then try to fix the pdf generation.
> Also the Sphinx framework should be able to generate pdf files too.
> Unfortunately it took my almost the whole night to fix all things
> (it's 4:40am), so I won't be able to help much with ipython on Sunday,
> as I will have to work on other things. But I'll be available if you
> need to explain anything regarding my patches.
Thanks so much! This is great, I hope you can get some rest, and
don't worry for now. Let me know when you have a minute to look at
the xml2rst business for the other docs, since that would be the
remaining piece missing.
> Enjoy hacking at Gaels,
We certainly are: the hospitality given by him and his parents has
been amazing. Chalk one to great open source development sponsorship!
More information about the IPython-dev