[IPython-dev] gh-pages problem...

Darren Dale dsdale24 at gmail.com
Mon Jan 24 08:54:00 EST 2011


On Sun, Jan 23, 2011 at 11:56 PM, Fernando Perez <fperez.net at gmail.com> wrote:
> 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

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.



More information about the IPython-dev mailing list