Initial docs setup

This commit is contained in:
Darren Eberly
2021-02-21 01:03:19 -05:00
parent cf5f693da3
commit 2a5e475c93
5 changed files with 115 additions and 99 deletions

View File

@@ -1,17 +1,11 @@
PyTiled Parser
==============
.. image:: 10_ladders_and_more.png
:width: 50%
PyTiled Parser is a Python library for parsing `Tiled Map Editor`_ (`.json`) files used to generate maps and levels for 2D games.
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.
PyTiled Parser is not tied to any particular graphics library, and can be used
with Arcade_, Pyglet_, Pygame_, and more.
API Documentation
API documentation
-----------------
.. toctree::
@@ -19,18 +13,8 @@ API Documentation
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
For More Info
-------------
* `PyTiled Parser on GitHub <https://github.com/pvcraven/pytiled_parser>`_
* `PyTiled Parser on PyPi <https://pypi.org/project/pytiled-parser/>`_
* `PyTiled Parser on Github <https://github.com/beefy-swain/pytiled_parser>`_
* `PyTiled Parser on PyPi <https://pypi.org/project/pytiled-parser/>`_