mirror of
https://github.com/OMGeeky/pytiled_parser.git
synced 2026-01-03 18:08:46 +01:00
Initial work on mkdocs documentation
This commit is contained in:
Darren Eberly
@@ -1,20 +0,0 @@
|
||||
# Minimal makefile for Sphinx documentation
|
||||
#
|
||||
|
||||
# You can set these variables from the command line, and also
|
||||
# from the environment for the first two.
|
||||
SPHINXOPTS ?=
|
||||
SPHINXBUILD ?= sphinx-build
|
||||
SOURCEDIR = source
|
||||
BUILDDIR = build
|
||||
|
||||
# Put it first so that "make" without argument is like "make help".
|
||||
help:
|
||||
@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
|
||||
|
||||
.PHONY: help Makefile
|
||||
|
||||
# Catch-all target: route all unknown targets to Sphinx using the new
|
||||
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
|
||||
%: Makefile
|
||||
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
|
||||
7
docs/index.md
Normal file
7
docs/index.md
Normal file
@@ -0,0 +1,7 @@
|
||||
# PyTiled Parser
|
||||
|
||||
PyTiled Parser is a Python Library for parsing maps made with the [Tiled Map Editor](https://www.mapeditor.org) for 2D games in a strictly typed fashion.
|
||||
|
||||
PyTiled Parser is not tied to any particular graphics library, and as such could be used with [Arcade](https://api.arcade.academy), [Pyglet](https://pyglet.readthedocs.io), [Pygame](https://www.pygame.org/news), or any other Python graphics library.
|
||||
|
||||
While we don't offer any direct integrations to other libraries/frameworks, [Arcade](https://api.arcade.academy) has full integration for PyTiled Parser out of the box, and would be a good resource to use as an example implementation.
|
||||
@@ -1,35 +0,0 @@
|
||||
@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
|
||||
3
docs/reference/common_types.md
Normal file
3
docs/reference/common_types.md
Normal file
@@ -0,0 +1,3 @@
|
||||
# Common Types
|
||||
|
||||
::: pytiled_parser.common_types
|
||||
1
docs/reference/layer.md
Normal file
1
docs/reference/layer.md
Normal file
@@ -0,0 +1 @@
|
||||
# Layer
|
||||
3
docs/reference/parser.md
Normal file
3
docs/reference/parser.md
Normal file
@@ -0,0 +1,3 @@
|
||||
# Parser
|
||||
|
||||
::: pytiled_parser.parser
|
||||
1
docs/reference/properties.md
Normal file
1
docs/reference/properties.md
Normal file
@@ -0,0 +1 @@
|
||||
# Properties
|
||||
3
docs/reference/tiled_map.md
Normal file
3
docs/reference/tiled_map.md
Normal file
@@ -0,0 +1,3 @@
|
||||
# tiled_map
|
||||
|
||||
::: pytiled_parser.tiled_map
|
||||
1
docs/reference/tiled_object.md
Normal file
1
docs/reference/tiled_object.md
Normal file
@@ -0,0 +1 @@
|
||||
# Tiled Object
|
||||
1
docs/reference/tileset.md
Normal file
1
docs/reference/tileset.md
Normal file
@@ -0,0 +1 @@
|
||||
# TileSet
|
||||
5
docs/reference/wang_set.md
Normal file
5
docs/reference/wang_set.md
Normal file
@@ -0,0 +1,5 @@
|
||||
# wang_set
|
||||
|
||||
::: pytiled_parser.wang_set
|
||||
rendering:
|
||||
members_order: source
|
||||
3
docs/reference/world.md
Normal file
3
docs/reference/world.md
Normal file
@@ -0,0 +1,3 @@
|
||||
# Worlds
|
||||
|
||||
::: pytiled_parser.world
|
||||
@@ -1,59 +0,0 @@
|
||||
PyTiled Parser API
|
||||
==================
|
||||
|
||||
pytiled\_parser.common\_types
|
||||
------------------------------------
|
||||
|
||||
.. automodule:: pytiled_parser.common_types
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
pytiled\_parser.layer
|
||||
----------------------------
|
||||
|
||||
.. 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:
|
||||
@@ -1,64 +0,0 @@
|
||||
# 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:
|
||||
# https://www.sphinx-doc.org/en/master/usage/configuration.html
|
||||
|
||||
# -- 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 = '2021, Beefy-Swain, Cleptomania'
|
||||
author = 'Beefy-Swain, Cleptomania'
|
||||
|
||||
# The full version, including alpha/beta/rc tags
|
||||
release = '1.0.0'
|
||||
|
||||
|
||||
# -- 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.autodoc',
|
||||
'sphinx.ext.coverage',
|
||||
'sphinx.ext.viewcode',
|
||||
'sphinx.ext.napoleon',
|
||||
]
|
||||
|
||||
# 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 = []
|
||||
|
||||
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'
|
||||
|
||||
# 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']
|
||||
@@ -1,20 +0,0 @@
|
||||
PyTiled Parser
|
||||
==============
|
||||
|
||||
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 not tied to any particular graphics library, and can be used with Arcade_, Pyglet_, Pygame_, and more.
|
||||
|
||||
API documentation
|
||||
-----------------
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
|
||||
api
|
||||
|
||||
For More Info
|
||||
-------------
|
||||
|
||||
* `PyTiled Parser on Github <https://github.com/beefy-swain/pytiled_parser>`_
|
||||
* `PyTiled Parser on PyPi <https://pypi.org/project/pytiled-parser/>`_
|
||||
Reference in New Issue
Block a user