On 17 June 2012 17:59, Txema Vicente <[email protected]> wrote:
> You need Sphinx (1.1.3) and this files in pyglet/doc folder from current
> repository:
> http://code.nabla.net/doc/pyglet/doc.zip
Excellent, I've managed to build the docs now even though there's a
considerable WARNING output - which is still an improvement over what
I was able to generate with epydoc :-)
I'm not confident enough with Sphinx to mess with the style stuff -
would it be possible to get a style that more closely matches the
current website style before I commit these changes to the repository?
> The new "event" object is defined in conf.py, I patched
> sphinx.ext.autosummary.generate to:
> - Mark methods having ":event:" in __doc__ as events.
> - Skip all members starting with "PFN" or "GL"
> See doc/ext/autosummary/generate.py
This needs to be recorded somewhere useful, but I honestly don't know
where. Perhaps some "documentation documentation"? :-)
Assuming the sphinx migration goes well (and it appears to be) I'll
look at replacing all the is_epydoc flag checks with is_sphinx for
sanity's sake (well, getting rid of the flag would be saner but
unrealistic at this point.)
I'm a little confused by the samples discussion: what sort of samples
were you thinking of? (there being code samples in the programming
guide and API docs already). Are you thinking of including code from
the examples directory in the documentation? Or are there just gaps in
the samples in the existing docs?
Richard
--
You received this message because you are subscribed to the Google Groups
"pyglet-users" group.
To post to this group, send email to [email protected].
To unsubscribe from this group, send email to
[email protected].
For more options, visit this group at
http://groups.google.com/group/pyglet-users?hl=en.
