https://github.com/not-na/peng3d_sphinxext

Sphinx Extension adding Support for peng3d events
https://github.com/not-na/peng3d_sphinxext

peng3d python python3 sphinx sphinx-extension sphinx-plugin

Last synced: 12 months ago
JSON representation

Sphinx Extension adding Support for peng3d events

• Host: GitHub
• URL: https://github.com/not-na/peng3d_sphinxext
• Owner: not-na
• Created: 2017-05-27T16:53:42.000Z (about 9 years ago)
• Default Branch: master
• Last Pushed: 2017-05-27T17:45:52.000Z (about 9 years ago)
• Last Synced: 2025-05-18T07:40:52.997Z (about 1 year ago)
• Topics: peng3d, python, python3, sphinx, sphinx-extension, sphinx-plugin
• Language: Python
• Size: 5.86 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

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