OMGeeky/pytiled_parser
1
0
Fork 0
mirror of https://github.com/OMGeeky/pytiled_parser.git synced 2026-02-23 15:49:52 +01:00
Code Issues Packages Projects Releases Wiki Activity

Initial docs setup

Browse Source
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
Download Patch File Download Diff File Expand all files Collapse all files

70
docs/make.bat
View File

@@ -1,35 +1,35 @@
@ECHO OFF @ECHO OFF
pushd %~dp0 pushd %~dp0
REM Command file for Sphinx documentation REM Command file for Sphinx documentation
if "%SPHINXBUILD%" == "" ( if "%SPHINXBUILD%" == "" (
set SPHINXBUILD=sphinx-build set SPHINXBUILD=sphinx-build
) )
set SOURCEDIR=source set SOURCEDIR=source
set BUILDDIR=build set BUILDDIR=build
if "%1" == "" goto help if "%1" == "" goto help
%SPHINXBUILD% >NUL 2>NUL %SPHINXBUILD% >NUL 2>NUL
if errorlevel 9009 ( if errorlevel 9009 (
echo. echo.
echo.The 'sphinx-build' command was not found. Make sure you have Sphinx echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
echo.installed, then set the SPHINXBUILD environment variable to point echo.installed, then set the SPHINXBUILD environment variable to point
echo.to the full path of the 'sphinx-build' executable. Alternatively you echo.to the full path of the 'sphinx-build' executable. Alternatively you
echo.may add the Sphinx directory to PATH. echo.may add the Sphinx directory to PATH.
echo. echo.
echo.If you don't have Sphinx installed, grab it from echo.If you don't have Sphinx installed, grab it from
echo.http://sphinx-doc.org/ echo.http://sphinx-doc.org/
exit /b 1 exit /b 1
) )
%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O% %SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
goto end goto end
:help :help
%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O% %SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
:end :end
popd popd

BIN
docs/source/10_ladders_and_more.png
View File

Binary file not shown.
Side by Side

Before

Width:  |  Height:  |  Size: 59 KiB

68
docs/source/api.rst
View File

@@ -1,23 +1,59 @@
.. _pytiled-api:
PyTiled Parser API PyTiled Parser API
================== ==================
This page documents the Application Programming Interface (API) pytiled\_parser.common\_types
for the PyTiled Parser library. ------------------------------------
.. automodule:: pytiled_parser.xml_parser .. automodule:: pytiled_parser.common_types
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:
.. automodule:: pytiled_parser.objects pytiled\_parser.layer
:members: ----------------------------
:undoc-members:
:show-inheritance:
.. automodule:: pytiled_parser.utilities .. automodule:: pytiled_parser.layer
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:
pytiled\_parser.properties
---------------------------------
.. automodule:: pytiled_parser.properties
:members:
:undoc-members:
:show-inheritance:
pytiled\_parser.tiled\_map
---------------------------------
.. automodule:: pytiled_parser.tiled_map
:members:
:undoc-members:
:show-inheritance:
pytiled\_parser.tiled\_object
------------------------------------
.. automodule:: pytiled_parser.tiled_object
:members:
:undoc-members:
:show-inheritance:
pytiled\_parser.tileset
------------------------------
.. automodule:: pytiled_parser.tileset
:members:
:undoc-members:
:show-inheritance:
pytiled\_parser.util
---------------------------
.. automodule:: pytiled_parser.util
:members:
:undoc-members:
:show-inheritance:

50
docs/source/conf.py
View File

@@ -2,7 +2,7 @@
# #
# This file only contains a selection of the most common options. For a full # This file only contains a selection of the most common options. For a full
# list see the documentation: # list see the documentation:
# http://www.sphinx-doc.org/en/master/config # https://www.sphinx-doc.org/en/master/usage/configuration.html
# -- Path setup -------------------------------------------------------------- # -- Path setup --------------------------------------------------------------
@@ -10,21 +10,20 @@
# add these directories to sys.path here. If the directory is relative to the # 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. # 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 -----------------------------------------------------
import os import os
import sys import sys
project = "PyTiled Parser" sys.path.insert(0, os.path.abspath('../..'))
copyright = "2019, Beefy-Swain"
author = "Beefy-Swain" # -- Project information -----------------------------------------------------
project = 'PyTiled Parser'
copyright = '2021, Beefy-Swain, Cleptomania'
author = 'Beefy-Swain, Cleptomania'
# The full version, including alpha/beta/rc tags
release = '1.0.0'
sys.path.insert(0, os.path.abspath("../.."))
# -- General configuration --------------------------------------------------- # -- General configuration ---------------------------------------------------
@@ -32,37 +31,34 @@ sys.path.insert(0, os.path.abspath("../.."))
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones. # ones.
extensions = [ extensions = [
"sphinx.ext.autodoc", 'sphinx.ext.autodoc',
"sphinx.ext.intersphinx", 'sphinx.ext.coverage',
"sphinx.ext.todo", 'sphinx.ext.viewcode',
"sphinx.ext.coverage", 'sphinx.ext.napoleon',
"sphinx.ext.ifconfig",
"sphinx.ext.viewcode",
] ]
# Add any paths that contain templates here, relative to this directory. # Add any paths that contain templates here, relative to this directory.
templates_path = ["_templates"] templates_path = ['_templates']
source_suffix = ".rst"
master_doc = "index"
pygments_style = "sphinx"
# List of patterns, relative to source directory, that match files and # List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files. # directories to ignore when looking for source files.
# This pattern also affects html_static_path and html_extra_path. # This pattern also affects html_static_path and html_extra_path.
exclude_patterns = [] exclude_patterns = []
source_suffix = '.rst'
master_doc = 'index'
pygments_style = 'sphinx'
# -- Options for HTML output ------------------------------------------------- # -- Options for HTML output -------------------------------------------------
# The theme to use for HTML and HTML Help pages. See the documentation for # The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes. # a list of builtin themes.
# #
html_theme = "sphinx_rtd_theme" html_theme = 'sphinx_rtd_theme'
# Add any paths that contain custom static files (such as style sheets) here, # 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, # relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css". # so a file named "default.css" will overwrite the builtin "default.css".
html_static_path = ["_static"] html_static_path = ['_static']

26
docs/source/index.rst
View File

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