Documentation updates

docs/source/api.rst

@@ -0,0 +1,23 @@
+.. _pytiled-api:
+
+PyTiled Parser API
+==================
+
+This page documents the Application Programming Interface (API)
+for the PyTiled Parser library.
+
+.. automodule:: pytiled_parser.xml_parser
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+.. automodule:: pytiled_parser.objects
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+.. automodule:: pytiled_parser.utilities
+    :members:
+    :undoc-members:
+    :show-inheritance:
+

docs/source/conf.py

@@ -0,0 +1,51 @@
+# Configuration file for the Sphinx documentation builder.
+#
+# This file only contains a selection of the most common options. For a full
+# list see the documentation:
+# http://www.sphinx-doc.org/en/master/config
+
+# -- Path setup --------------------------------------------------------------
+
+# If extensions (or modules to document with autodoc) are in another directory,
+# add these directories to sys.path here. If the directory is relative to the
+# documentation root, use os.path.abspath to make it absolute, like shown here.
+#
+# import os
+# import sys
+# sys.path.insert(0, os.path.abspath('.'))
+
+
+# -- Project information -----------------------------------------------------
+
+project = 'PyTiled Parser'
+copyright = '2019, Beefy-Swain'
+author = 'Beefy-Swain'
+
+
+# -- General configuration ---------------------------------------------------
+
+# Add any Sphinx extension module names here, as strings. They can be
+# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
+# ones.
+extensions = ['sphinx.ext.todo', 'sphinx.ext.viewcode', 'sphinx.ext.autodoc']
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['_templates']
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+# This pattern also affects html_static_path and html_extra_path.
+exclude_patterns = []
+
+
+# -- Options for HTML output -------------------------------------------------
+
+# The theme to use for HTML and HTML Help pages.  See the documentation for
+# a list of builtin themes.
+#
+html_theme = 'sphinx_rtd_theme'
+
+# Add any paths that contain custom static files (such as style sheets) here,
+# relative to this directory. They are copied after the builtin static files,
+# so a file named "default.css" will overwrite the builtin "default.css".
+html_static_path = ['_static']

docs/source/index.rst

@@ -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