-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
2 changed files
with
24 additions
and
3 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,21 @@ | ||
``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` ``. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters