Skip to content

Commit

Permalink
Added README.rst and fixed typo
Browse files Browse the repository at this point in the history
  • Loading branch information
not-na committed May 27, 2017
1 parent cbebedc commit f08a370
Show file tree
Hide file tree
Showing 2 changed files with 24 additions and 3 deletions.
21 changes: 21 additions & 0 deletions README.rst
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` ``.
6 changes: 3 additions & 3 deletions setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -40,19 +40,19 @@
DistributionMetadata.download_url = None

try:
longdesc = open("README.txt","r").read()
longdesc = open("README.rst","r").read()
except Exception:
longdesc = "Sphinx Extension adding Support for peng3d events"


setup(name='peng3d_sphinxext',
version="1.0",
version="1.0post1",
description="Sphinx Extension adding Support for peng3d events", # from the github repo
long_description=longdesc,
author="notna",
author_email="notna@apparat.org",
url="https://github.com/not-na/peng3d_sphinxext",
packages=['peng3d_sphinxext'],
py_modules=['peng3d_sphinxext'],
requires=["sphinx","sphinxcontrib_domaintools"],
provides=["peng3d_sphinxext"],
classifiers=[
Expand Down

0 comments on commit f08a370

Please sign in to comment.