Initialization

.gitattributes

@@ -0,0 +1,2 @@
+# Auto detect text files and perform LF normalization
+* text=auto

.gitignore

@@ -0,0 +1,3 @@
+
+\.vscode/
+_build/

Informations/changelog.rst

@@ -0,0 +1,7 @@
+Changelog
+=========
+
+V 4.0.0 - XX/XX/XX (INDEV)
+--------------------------
+
+- Complete rework on PyEngine

Informations/faq.rst

@@ -0,0 +1,35 @@
+FAQ
+===
+
+What is PyEngine?
+------------------------
+
+PyEngine is a game engine for creating games
+2D videos more easily.
+
+Why create PyEngine?
+--------------------
+
+To create a video game in python, there is already the very good PyGame.
+
+But when I created my game, I had to create systems 
+(such as the entity system) that are useful for all.
+So I chose to create PyEngine (which uses PyGame itself)
+(And then it allows a good training in Python).
+
+What are the dependencies of PyEngine?
+--------------------------------------
+
+Apart from Python, PyEngine uses PyGame and PyQt.
+But games builded with PyEngine only use PyGame.
+
+What are the platforms where PyEngine can be used?
+--------------------------------------------------
+
+If you can use PyGame, PyQt and Python, you can use PyEngine.
+
+I would like to participate in the development of PyEngine, how do I do it?
+----------------------------------------------------------------------------
+
+Send me a message by Discord (LavaPower / Lyos#2480) to see what
+you can do or go to GitHub

Informations/introduction.rst

@@ -0,0 +1,11 @@
+Introduction
+============
+
+PyEngine was created by LavaPower.
+
+PyEngine relies on PyGame to work. It was made to be
+used on 2D games of all types: Platformer, Pong, Casse bricks...
+
+You can find tutorials, examples and documentation of the different classes.
+
+.. note:: PyEngine is still very young and still very limited.

Informations/telechargement-et-installation.rst

@@ -0,0 +1,7 @@
+Download and Installation
+==============================
+
+- Have Python, PyGame and PyQt installed
+- Download and decompress github files (http://github.com/Lycos-Novation/PyEngine4)
+- PyEngine is downloaded and installed
+

Makefile

@@ -0,0 +1,19 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+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)

conf.py

@@ -0,0 +1,72 @@
+# 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('.'))
+from recommonmark.parser import CommonMarkParser
+
+source_parsers = {
+    '.md': CommonMarkParser,
+}
+
+
+# -- Project information -----------------------------------------------------
+
+project = 'PyEngine4'
+copyright = '2021, LycosNovation'
+author = 'LavaPower'
+
+version = '4.0'
+# The full version, including alpha/beta/rc tags
+release = '4.0.0-indev'
+
+
+# -- 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.napoleon']
+
+autoclass_content = 'init'
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['_templates']
+source_suffix = ['.rst', '.md']
+master_doc = 'index'
+
+# 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']
+pygments_style = None
+
+
+# -- 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']

index.rst

@@ -0,0 +1,30 @@
+PyEngine4 - Doc
+===============
+
+Welcome to documentation of PyEngine4.
+
+PyEngine4 is constantly under development, the documentation 
+is therefore subject to change.
+Feel free to come back to it as soon as you have a problem.
+
+.. note:: It is important to remember that PyEngine is an OpenSource project developed by non-professionals.
+    You can also participate with Github.
+
+Sommaire :
+
+.. toctree::
+   :maxdepth: 1
+   :caption: Informations
+   :name: sec-general
+
+   Informations/introduction
+   Informations/telechargement-et-installation
+   Informations/faq
+   Informations/changelog
+
+Indices and tables
+==================
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`
+

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%
+goto end
+
+:help
+%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS%
+
+:end
+popd