peng3d_sphinxext

Sphinx Extension adding Support for peng3d events


Keywords
peng3d, python, python3, sphinx, sphinx-extension, sphinx-plugin
Licenses
GPL-3.0/GPL-3.0+
Install
pip install peng3d_sphinxext==1.0

Documentation

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` .