Hola.
It is done.
For the record:
The only 2 lines that change in pyglet/__init__.py are:
359 if not _is_epydoc: -> If True:
398 if _is_epydoc: -> If False:
But I suppose that changes break epydoc, it should be cleaned and evicted.
All the rest ! is in pyglet/doc:
- Requires sphinx installed
- conf.py contains standard sphinx configuration, plus:
* patched ext.autosummary taken from sphinx 1.1.3
- Generate new constants for templates.
* Module and member filters.
* Reads directories to create a submodule dict.
* EventDocumenter class
* Save files internals/blacklist.rst, build.rst on each build
- reST entry point is index.txt, and ALL txt files in will be processed,
recursively.
- "make html" will save _build/html/warnings.txt and around 20 Mb more.
- If you change the api generation process, remember to delete the api
and _build folders.
- generated .doctree folder is big and can be deleted.
Now I know reST fu.
Hasta luego.
El 22/06/2012 8:16, Richard Jones escribió:
Please, go for it! :-)
Richard
On 22 June 2012 03:23, Winston Wolff <[email protected]> wrote:
That looks great. Shall I import it tomorrow (Friday)?
-ww
On Jun 21, 2012, at 9:53 AM, Txema Vicente wrote:
I think documentarion is complete and clean, so ready to commit.
Please check and let me know if you see any problem in the content generation.
This needs to be recorded somewhere useful, but I honestly don't know
where. Perhaps some "documentation documentation"? :-)
http://code.nabla.net/doc/pyglet/internal/doc.html#generation
The replacement of _is_epydoc with _is_doc, the warnings list below, and other
improvements (like examples role), may be others commit.
Warnings
--------
pyglet.app.base.EventLoop.sleep:14: WARNING: Field list ends without a blank
line; unexpected unindent.
pyglet.app.EventLoop.sleep:14: WARNING: Field list ends without a blank line;
unexpected unindent.
pyglet.input.base.Joystick.on_joyaxis_motion:4: ERROR: Unexpected indentation.
pyglet.input.base.Joystick.on_joyaxis_motion:5: WARNING: Block quote ends
without a blank line; unexpected unindent.
pyglet.input.base.Joystick.on_joybutton_press:4: ERROR: Unexpected indentation.
pyglet.input.base.Joystick.on_joybutton_press:5: WARNING: Block quote ends
without a blank line; unexpected unindent.
pyglet.input.base.Joystick.on_joybutton_press:5: WARNING: Inline interpreted
text or phrase reference start-string without end-string.
pyglet.input.base.Joystick.on_joybutton_release:4: ERROR: Unexpected
indentation.
pyglet.input.base.Joystick.on_joybutton_release:5: WARNING: Block quote ends
without a blank line; unexpected unindent.
pyglet.input.base.Joystick.on_joybutton_release:5: WARNING: Inline interpreted
text or phrase reference start-string without end-string.
pyglet.input.base.Joystick.on_joyhat_motion:4: ERROR: Unexpected indentation.
pyglet.input.base.Joystick.on_joyhat_motion:5: WARNING: Block quote ends
without a blank line; unexpected unindent.
pyglet.input.Joystick.on_joyaxis_motion:4: ERROR: Unexpected indentation.
pyglet.input.Joystick.on_joyaxis_motion:5: WARNING: Block quote ends without a
blank line; unexpected unindent.
pyglet.input.Joystick.on_joybutton_press:4: ERROR: Unexpected indentation.
pyglet.input.Joystick.on_joybutton_press:5: WARNING: Block quote ends without a
blank line; unexpected unindent.
pyglet.input.Joystick.on_joybutton_press:5: WARNING: Inline interpreted text or
phrase reference start-string without end-string.
pyglet.input.Joystick.on_joybutton_release:4: ERROR: Unexpected indentation.
pyglet.input.Joystick.on_joybutton_release:5: WARNING: Block quote ends without
a blank line; unexpected unindent.
pyglet.input.Joystick.on_joybutton_release:5: WARNING: Inline interpreted text
or phrase reference start-string without end-string.
pyglet.input.Joystick.on_joyhat_motion:4: ERROR: Unexpected indentation.
pyglet.input.Joystick.on_joyhat_motion:5: WARNING: Block quote ends without a
blank line; unexpected unindent.
tests.test:81: WARNING: Definition list ends without a blank line; unexpected
unindent.
tests.test:89: WARNING: Option list ends without a blank line; unexpected
unindent.
tests.test:98: WARNING: Definition list ends without a blank line; unexpected
unindent.
tests.test:100: WARNING: Option list ends without a blank line; unexpected
unindent.
doc\internal\dist.txt:10: ERROR: Unexpected indentation.
doc\programming_guide\graphics.txt:32: ERROR: Unknown target name: "opengl
programming guide".
doc\programming_guide\input.txt:105: WARNING: Inline interpreted text or phrase
reference start-string without end-string.
--
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.
--
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.
--
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.
