diff --git a/docs/make.bat b/docs/make.bat index 9534b01..6247f7e 100644 --- a/docs/make.bat +++ b/docs/make.bat @@ -1,35 +1,35 @@ -@ECHO OFF - -pushd %~dp0 - -REM Command file for Sphinx documentation - -if "%SPHINXBUILD%" == "" ( - set SPHINXBUILD=sphinx-build -) -set SOURCEDIR=source -set BUILDDIR=build - -if "%1" == "" goto help - -%SPHINXBUILD% >NUL 2>NUL -if errorlevel 9009 ( - echo. - echo.The 'sphinx-build' command was not found. Make sure you have Sphinx - echo.installed, then set the SPHINXBUILD environment variable to point - echo.to the full path of the 'sphinx-build' executable. Alternatively you - echo.may add the Sphinx directory to PATH. - echo. - echo.If you don't have Sphinx installed, grab it from - echo.http://sphinx-doc.org/ - exit /b 1 -) - -%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O% -goto end - -:help -%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O% - -:end -popd +@ECHO OFF + +pushd %~dp0 + +REM Command file for Sphinx documentation + +if "%SPHINXBUILD%" == "" ( + set SPHINXBUILD=sphinx-build +) +set SOURCEDIR=source +set BUILDDIR=build + +if "%1" == "" goto help + +%SPHINXBUILD% >NUL 2>NUL +if errorlevel 9009 ( + echo. + echo.The 'sphinx-build' command was not found. Make sure you have Sphinx + echo.installed, then set the SPHINXBUILD environment variable to point + echo.to the full path of the 'sphinx-build' executable. Alternatively you + echo.may add the Sphinx directory to PATH. + echo. + echo.If you don't have Sphinx installed, grab it from + echo.http://sphinx-doc.org/ + exit /b 1 +) + +%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O% +goto end + +:help +%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O% + +:end +popd diff --git a/docs/source/10_ladders_and_more.png b/docs/source/10_ladders_and_more.png deleted file mode 100644 index 115e0c4..0000000 Binary files a/docs/source/10_ladders_and_more.png and /dev/null differ diff --git a/docs/source/api.rst b/docs/source/api.rst index 5621700..b4e7e41 100644 --- a/docs/source/api.rst +++ b/docs/source/api.rst @@ -1,23 +1,59 @@ -.. _pytiled-api: - PyTiled Parser API ================== -This page documents the Application Programming Interface (API) -for the PyTiled Parser library. +pytiled\_parser.common\_types +------------------------------------ -.. automodule:: pytiled_parser.xml_parser - :members: - :undoc-members: - :show-inheritance: +.. automodule:: pytiled_parser.common_types + :members: + :undoc-members: + :show-inheritance: -.. automodule:: pytiled_parser.objects - :members: - :undoc-members: - :show-inheritance: +pytiled\_parser.layer +---------------------------- -.. automodule:: pytiled_parser.utilities - :members: - :undoc-members: - :show-inheritance: +.. automodule:: pytiled_parser.layer + :members: + :undoc-members: + :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: diff --git a/docs/source/conf.py b/docs/source/conf.py index daafdf8..4054de5 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -2,7 +2,7 @@ # # 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 +# https://www.sphinx-doc.org/en/master/usage/configuration.html # -- Path setup -------------------------------------------------------------- @@ -10,21 +10,20 @@ # 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 ----------------------------------------------------- - import os import sys -project = "PyTiled Parser" -copyright = "2019, Beefy-Swain" -author = "Beefy-Swain" +sys.path.insert(0, os.path.abspath('../..')) + +# -- 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 --------------------------------------------------- @@ -32,37 +31,34 @@ sys.path.insert(0, os.path.abspath("../..")) # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom # ones. extensions = [ - "sphinx.ext.autodoc", - "sphinx.ext.intersphinx", - "sphinx.ext.todo", - "sphinx.ext.coverage", - "sphinx.ext.ifconfig", - "sphinx.ext.viewcode", + 'sphinx.ext.autodoc', + 'sphinx.ext.coverage', + 'sphinx.ext.viewcode', + 'sphinx.ext.napoleon', ] # Add any paths that contain templates here, relative to this directory. -templates_path = ["_templates"] - -source_suffix = ".rst" - -master_doc = "index" - -pygments_style = "sphinx" +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 = [] +source_suffix = '.rst' + +master_doc = 'index' + +pygments_style = 'sphinx' # -- 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" +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"] +html_static_path = ['_static'] diff --git a/docs/source/index.rst b/docs/source/index.rst index 8b5271b..1067262 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -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 `_ - -.. _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 `_ -* `PyTiled Parser on PyPi `_ +* `PyTiled Parser on Github `_ +* `PyTiled Parser on PyPi `_ \ No newline at end of file