Hi
AFAIK __docformat__ is epydoc specific and can be removed.
__version__ = '$Id$', no clue what it is, but I don't like it either.
Documentation only checks pyglet.version, I would expect only a
pyglet.__version__="1.2"
Also, sys._is_epydoc could be replaced for sys._is_doc
About format, mostly is ReST, but there are things that are not by the
book. This is not a problem, If the style is well defined, we can
convert anything to true ReST markup at build time. Some things would
have to be revised: The :Ivariables: blocks, the "Since pyglet 1.x"
notes ...
Cheers.
El 11/12/2013 20:30, Jorge Cardoso Leitão escribió:
I agree with the changes!
Anything else about the documentation generation, talk now that I'm warm.
Do we still need
__docformat__ = 'restructuredtext'
__version__ = '$Id$'
in every file? I thought we were using restructuredtextall the way.
What about sticking to one format, and migrate the others to that one?
Seems to me that having code telling which doc format is being used is
rather... strange.
If work is problem, please post somewhere the list of files with other
formats so we can migrate them with time.
Cheers,
Jorge
On Wednesday, December 11, 2013 7:44:51 PM UTC+1, Txema Vicente wrote:
Hi.
I'm working on changing some things in the documentation
* Autosummary: Remove all the *.base modules from the docs, its
members are already documented at the parent module.
* Event Documenter: a method is an event if ":event:" in __doc__
-> is an event if method name is in im_class.event_types
* Class documentation template: Layout change, prevents duplicate
index entries.
I think it would be useful to add a small sphinx extension to
modify some docstrings when building the docs:
* Remove all the :event: markers form the docs.
* Parameters notation: pyglet does this, and it looks good at the
source code:
:Parameters:
`name` : str
The name of the display to connect to.
`x_screen` : int
The X11 screen number to use.
But we can convert this to the ugly sphinx :param name:
notation (ONLY when building the docs), and it looks better.
* Ivariables: change to "Instance attributes" (or what?)
And with all this changes, the docs looks like this:
http://code.nabla.net/doc/testing/pyglet/
<http://code.nabla.net/doc/testing/pyglet/>
Sounds good to make this changes, do you see something wrong?
Anything else about the documentation generation, talk now that
I'm warm.
Regards.
--
You received this message because you are subscribed to the Google
Groups "pyglet-users" group.
To unsubscribe from this group and stop receiving emails from it, send
an email to [email protected].
To post to this group, send email to [email protected].
Visit this group at http://groups.google.com/group/pyglet-users.
For more options, visit https://groups.google.com/groups/opt_out.
--
You received this message because you are subscribed to the Google Groups
"pyglet-users" group.
To unsubscribe from this group and stop receiving emails from it, send an email
to [email protected].
To post to this group, send email to [email protected].
Visit this group at http://groups.google.com/group/pyglet-users.
For more options, visit https://groups.google.com/groups/opt_out.
