Skip to main content

Sphinx Extension adding Support for peng3d events

Project description

``peng3d_sphinxext`` - A Sphinx plugin adding support for `peng3d <https://github.com/not-na/peng3d>`_ events
=============================================================================================================

This Sphinx plugin adds support for `peng3d Events <http://peng3d.readthedocs.io/en/latest/events.html>`_\ .
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` ``.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Filename, size & hash SHA256 hash help File type Python version Upload date
peng3d_sphinxext-1.0.post1-py3.5.egg (3.1 kB) Copy SHA256 hash SHA256 Egg 3.5
peng3d_sphinxext-1.0.post1.tar.gz (2.6 kB) Copy SHA256 hash SHA256 Source None

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page