diff --git a/.gitignore b/.gitignore index 215a7f5..6ee720a 100644 --- a/.gitignore +++ b/.gitignore @@ -1,3 +1,4 @@ /.idea/ __pycache__ /venv/ +/doc/_build/ diff --git a/doc/Makefile b/doc/Makefile new file mode 100644 index 0000000..d4bb2cb --- /dev/null +++ b/doc/Makefile @@ -0,0 +1,20 @@ +# 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 = . +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) diff --git a/doc/conf.py b/doc/conf.py new file mode 100644 index 0000000..a4312bc --- /dev/null +++ b/doc/conf.py @@ -0,0 +1,62 @@ +# 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('..')) +# Path to modules +sys.path.insert(0, os.path.abspath('../src')) +sys.path.insert(0, os.path.abspath('../src/AI')) +sys.path.insert(0, os.path.abspath('../src/game')) +sys.path.insert(0, os.path.abspath('../src/entities')) +sys.path.insert(0, os.path.abspath('../src/ui')) + +# -- Project information ----------------------------------------------------- + +project = 'DSZI_Survival' +copyright = '2020, Michał Czekański, Marcin Kostrzewski, Jonatan Spaczyński, Mateusz Tylka' +author = 'Michał Czekański, Marcin Kostrzewski, Jonatan Spaczyński, Mateusz Tylka' + +# -- 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'] + +# Add any paths that contain templates here, relative to this directory. +templates_path = ['_templates'] + +# The language for content autogenerated by Sphinx. Refer to documentation +# for a list of supported languages. +# +# This is also used if you do content translation via gettext catalogs. +# Usually you set "language" from the command line for these cases. +language = 'en' + +# 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 = ['_build', 'Thumbs.db', '.DS_Store'] + +# -- 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 = 'alabaster' + +# 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'] diff --git a/doc/index.rst b/doc/index.rst new file mode 100644 index 0000000..246620e --- /dev/null +++ b/doc/index.rst @@ -0,0 +1,24 @@ +.. DSZI_Survival documentation master file, created by +sphinx-quickstart on Thu May 14 13:16:10 2020. +You can adapt this file completely to your liking, but it should at least +contain the root `toctree` directive. + +Welcome to DSZI_Survival's documentation! +========================================= + +.. toctree:: + :maxdepth: 2 + :caption: Contents: + + src/game + src/entities + src/ui + src/ai + + +Indices and tables +================== + +* :ref:`genindex` +* :ref:`modindex` +* :ref:`search` diff --git a/doc/make.bat b/doc/make.bat new file mode 100644 index 0000000..922152e --- /dev/null +++ b/doc/make.bat @@ -0,0 +1,35 @@ +@ECHO OFF + +pushd %~dp0 + +REM Command file for Sphinx documentation + +if "%SPHINXBUILD%" == "" ( + set SPHINXBUILD=sphinx-build +) +set SOURCEDIR=. +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/doc/src/ai.rst b/doc/src/ai.rst new file mode 100644 index 0000000..7d088cf --- /dev/null +++ b/doc/src/ai.rst @@ -0,0 +1,10 @@ +AI +== + +.. automodule:: AutomaticMovement + :members: + :undoc-members: + +.. automodule:: AStarNode + :members: + :undoc-members: diff --git a/doc/src/entities.rst b/doc/src/entities.rst new file mode 100644 index 0000000..0612829 --- /dev/null +++ b/doc/src/entities.rst @@ -0,0 +1,32 @@ +Entities +======== + +.. automodule:: Entity + :members: + :undoc-members: + +.. automodule:: Player + :members: + :undoc-members: + :show-inheritance: + +.. automodule:: Interactable + :members: + :undoc-members: + :show-inheritance: + + +.. automodule:: Pickupable + :members: + :show-inheritance: + :undoc-members: + + +.. automodule:: Statistics + :members: + :undoc-members: + :show-inheritance: + +.. automodule:: Enums + :undoc-members: + :members: diff --git a/doc/src/game.rst b/doc/src/game.rst new file mode 100644 index 0000000..622c48e --- /dev/null +++ b/doc/src/game.rst @@ -0,0 +1,26 @@ +Game +==== + +.. automodule:: Game + :members: + :undoc-members: + +.. automodule:: Screen + :members: + :undoc-members: + +.. automodule:: EventManager + :members: + :undoc-members: + +.. automodule:: Map + :members: + :undoc-members: + +.. automodule:: TerrainTile + :members: + :undoc-members: + +.. automodule:: Timer + :members: + :undoc-members: diff --git a/doc/src/ui.rst b/doc/src/ui.rst new file mode 100644 index 0000000..55a507e --- /dev/null +++ b/doc/src/ui.rst @@ -0,0 +1,41 @@ +UI +== + +.. automodule:: Ui + :members: + :undoc-members: + +.. automodule:: UiBar + :show-inheritance: + :members: + :undoc-members: + +.. automodule:: UiButton + :show-inheritance: + :members: + :undoc-members: + +.. automodule:: UiConsole + :show-inheritance: + :members: + :undoc-members: + +.. automodule:: UiElement + :show-inheritance: + :members: + :undoc-members: + +.. automodule:: UiImage + :show-inheritance: + :members: + :undoc-members: + +.. automodule:: UiText + :show-inheritance: + :members: + :undoc-members: + +.. automodule:: UiWindow + :show-inheritance: + :members: + :undoc-members: