[Mesa-dev] adding driver specific docs in src/gallium/docs?

Rob Clark robdclark at gmail.com
Mon Jan 26 12:08:03 PST 2015


On Mon, Jan 26, 2015 at 2:19 PM, Brian Paul <brianp at vmware.com> wrote:
> On 01/26/2015 10:53 AM, Rob Clark wrote:
>>
>> Btw, I had started putting together some docs for freedreno "ir3"
>> compiler..  I was originally just going to use markdown, but the
>> graphviz plugin for sphinx is actually a bit too useful for this sort
>> of thing to ignore.
>>
>> Otoh setting up a whole doc tree for one page seems a bit overkill.  I
>> wonder how people would feel if I started adding this to the existing
>> src/gallium/docs tree (and enabled the grapviz plugin in conf.py)?
>
>
> The VMware guest driver is documented in docs/vmware-guest.html and linked
> to by contents.html.  Basically everything in docs/ gets mirrored to the
> website while src/gallium/docs/ doesn't.  Do you want your docs on the
> website too?
>

hmm, the docs/vmware-guest stuff appears to be disconnected from the
rst generated docs?

It would be convenient for it to show up *somewhere* but
http://gallium.readthedocs.org is sufficient.  It is really (driver
specific) developer docs rather than something end users would care
about

BR,
-R

> -Brian
>


More information about the mesa-dev mailing list