Documentation updates

This commit is contained in:
Paul Vincent Craven
2019-08-15 09:33:49 -05:00
parent 4f8a534921
commit 0670005d3e
10 changed files with 229 additions and 57 deletions

30
docs/source/index.rst Normal file
View File

@@ -0,0 +1,30 @@
PyTiled Parser
==============
.. image:: 10_ladders_and_more.png
:width: 50%
PyTiled Parser is a Python Library for parsing
`Tiled Map Editor`_ (`.tmx`) files used to generate
maps and levels for 2D top-down or side-scrolling games.
PyTiled Parser is not tied to any particular graphics library, and can be used
with Arcade_, Pyglet_, Pygame_, and more.
API Documentation
-----------------
.. toctree::
:maxdepth: 2
api
Examples
--------
* `Games using the Arcade library <http://arcade.academy/examples/index.html#tmx-files-tiled-map-editor>`_
.. _Tiled Map Editor: https://www.mapeditor.org/
.. _Arcade: http://arcade.academy
.. _Pyglet: https://pyglet.readthedocs.io/en/pyglet-1.3-maintenance/
.. _Pygame: https://www.pygame.org/news