On 24 June 2012 19:58, Txema Vicente <
tx...@nabla.net> wrote:
> - The Testing Framework is not documented now because you need the
> autosummary directive to generate api/tests.test.txt. (like pyglet.txt does)
Ah, darn, sorry! There's some other strangenesses going on with the
api doc generation as well (I have "doc/api/api/..." which is
definitely not right.) I've started fixing that, as well as my
breaking of api/tests.test.txt, but then I had to go off and fix
testpypi.python.org and that's kinda done me for the night. I'll have
another crack at the docs etc. tomorrow.
>> Also it'd be good to prune some of the OpenGL leaves from the API
>> docs. In a future version.
>
> I intentionally left those there, so if you search "glMultMatrixd" it is
> found somewhere.
> (I was even planning to include links to
http://www.opengl.org/sdk/docs/man/
> )
>
> But if the page is too long, a simple tweak in conf.py skip_member will
> prune easily.
I think my re-adding of the "Defined" section (by choosing the
"module.rst" template over the "package.rst") was a bad idea. It ends
up including a whole lot of symbols that offer almost no value to the
API doc reader.
Richard