[IPython-dev] gh-pages problem...
benjaminrk at gmail.com
Mon Jan 24 12:28:11 EST 2011
On Mon, Jan 24, 2011 at 09:20, Brian Granger <ellisonbg at gmail.com> wrote:
> On Mon, Jan 24, 2011 at 5:54 AM, Darren Dale <dsdale24 at gmail.com> wrote:
> > On Sun, Jan 23, 2011 at 11:56 PM, Fernando Perez <fperez.net at gmail.com>
> >> Hey folks,
> >> I'm really sorry that (due to 'real life' getting in the way) I missed
> >> several important discussions, in particular this one:
> >> https://github.com/ipython/ipython/issues/closed/#issue/239
> >> As I just mentioned to Brian during a chat we had, there's a problem
> >> with the default approach Github took to pages hosting: they put the
> >> pages in a separate DAG inside the repo (the gh-pages branch), but
> >> this means polluting the repo forever with all builds of the docs.
> >> Furthermore, if we want to host multiple versions of the docs (as we
> >> do today for each release and should continue doing), the storage
> >> requirements are going to balloon.
> >> Fortunately, there's a different approach that's easy to implement,
> >> adds only minimal work, and is completely clean. And I'd already
> >> written the tools for it :) For datarray, here's the gh-pages-hosted
> >> docs:
> >> http://fperez.github.com/datarray-doc/
> >> The basic idea is just to have a *separate* git repo that *only* hosts
> >> the gh-pages docs, in this case this one:
> >> https://github.com/fperez/datarray-doc
> > Just FYI, github also allows you to host a repository like:
> > https://github.com/ipython/ipython.github.com
> > which would render docs at http://ipython.github.com. I've started
> > doing so with a project of my own:
> > http://praxes.github.com
> I like this approach!
Yes, I think this is a good plan for the IPython site in general, but that's
a much bigger migration than just the sphinx docs.
> > Also, if you add a .nojekyll in the master branch of that repo (or the
> > gh-pages repo), github can serve the content as provided by sphinx,
> > without additional processing.
> Especially this. While we have a makefile that does the extra
> processing, it is just one more thing to maintain. What do others
The sphinx-github extension resolves the conflict easily, but .nojekyll is
definitely nicer. Does .nojekyll work with regular repo gh-pages, or just '
> > _______________________________________________
> > IPython-dev mailing list
> > IPython-dev at scipy.org
> > http://mail.scipy.org/mailman/listinfo/ipython-dev
> Brian E. Granger, Ph.D.
> Assistant Professor of Physics
> Cal Poly State University, San Luis Obispo
> bgranger at calpoly.edu
> ellisonbg at gmail.com
> IPython-dev mailing list
> IPython-dev at scipy.org
-------------- next part --------------
An HTML attachment was scrubbed...
More information about the IPython-dev