[Mesa-dev] Gallium docs online builds

Ilia Mirkin imirkin at alum.mit.edu
Wed Apr 2 14:52:56 PDT 2014


On Mon, Mar 31, 2014 at 12:43 PM, Ilia Mirkin <imirkin at alum.mit.edu> wrote:
> Hi everyone,
>
> I've set up a readthedocs.org build to point at the gallium docs:
>
> http://gallium.readthedocs.org/en/latest/
>
> I didn't find any publicly available built docs otherwise (except some
> rather outdated ones[1]), and this is able to build against the latest
> git and auto-updates without us doing anything (might need to set up a
> commit hook to get that to work, I'll investigate later). There are
> also versioned builds (tailing the respective branches) for 9.0 and
> later.
>
> I don't really like their default scheme, I'm more used to the
> "regular" one, it's selectable somehow (I think by making conf.py
> changes). But I thought I'd give it a shot, perhaps I'm just used to
> the other one but this one's fine too.
>
> If anyone is interested in being added as a maintainer, email me your
> readthedocs.org username. Conversely, if you hate the idea and think I
> should take this down, let me know, and I'll be happy to comply (if
> there's consensus).

Well, there hasn't been any response, which hopefully means that no
one outright hates it. Also no one has asked to be added as a
maintainer... hopefully I could recruit one or two volunteers, in case
I'm not around and a change needs to be made.

In order for it to rebuild stuff automatically, we need to do

curl -X POST http://readthedocs.org/build/gallium

in a post-commit hook. I guess that has to be added directly in the
mesa repo... who would I talk to about doing that?

Also, if someone in charge of mesa3d.org wants to add a
gallium-docs.mesa3d.org or something, here is how:

http://read-the-docs.readthedocs.org/en/latest/alternate_domains.html

(short version: adding a CNAME is enough.) At which point I can set
that up as a canonical URL. But that's completely optional.

  -ilia


More information about the mesa-dev mailing list