Skip to content

Latest commit

 

History

History
21 lines (13 loc) · 803 Bytes

README.rst

File metadata and controls

21 lines (13 loc) · 803 Bytes

peng3d_sphinxext - A Sphinx plugin adding support for peng3d events

This Sphinx plugin adds support for peng3d Events. It also supports old-style pyglet events sent via peng3d.

Short documentation

There are only two directives added by peng3d_sphinxext:

.. peng3d:event:: some:event.name

    Documentation for the event.

and

.. peng3d:pgevent:: on_pyglet_event

    Documentation for a pyglet event.

These directives can be referred to as usual, via ``:peng3d:event:`some:event.name` `` and ``:peng3d:pgevent:`on_pyglet_event` ``.