Tutorial part 2

Author: HexDecimal

.vscode/settings.json

@@ -127,6 +127,7 @@
         "DHLINE",
         "DISPLAYSWITCH",
         "dlopen",
+        "docstrings",
         "documentclass",
         "Doryen",
         "DPAD",
@@ -136,6 +137,7 @@
         "DTEEW",
         "dtype",
         "dtypes",
+        "dunder",
         "DVLINE",
         "elif",
         "endianness",
@@ -148,6 +150,7 @@
         "ffade",
         "fgcolor",
         "fheight",
+        "Flecs",
         "flto",
         "fmean",
         "fontx",
@@ -332,6 +335,7 @@
         "printn",
         "PRINTSCREEN",
         "propname",
+        "pushdown",
         "pycall",
         "pycparser",
         "pyinstaller",
@@ -346,6 +350,7 @@
         "quickstart",
         "QUOTEDBL",
         "RALT",
+        "randint",
         "randomizer",
         "rbutton",
         "RCTRL",

docs/conf.py

@@ -103,7 +103,7 @@
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.
 # This patterns also effect to html_static_path and html_extra_path
-exclude_patterns = ["_build", "Thumbs.db", ".DS_Store", "/epilog.rst"]
+exclude_patterns = ["_build", "Thumbs.db", ".DS_Store", "epilog.rst", "prolog.rst"]
 
 # The reST default role (used for this markup: `text`) to use for all
 # documents.
@@ -378,13 +378,14 @@
 napoleon_use_param = True
 napoleon_use_rtype = True
 
-rst_prolog = ".. include:: /prolog.rst"  # Added to the beginning of every source file.
-rst_epilog = ".. include:: /epilog.rst"  # Added to the end of every source file.
+rst_prolog = Path("prolog.rst").read_text(encoding="utf-8")  # Added to the beginning of every source file.
+rst_epilog = Path("epilog.rst").read_text(encoding="utf-8")  # Added to the end of every source file.
 
 # Example configuration for intersphinx: refer to the Python standard library.
 intersphinx_mapping = {
     "python": ("https://docs.python.org/3/", None),
     "numpy": ("https://numpy.org/doc/stable/", None),
+    "tcod-ecs": ("https://python-tcod-ecs.readthedocs.io/en/latest/", None),
 }
 
 os.environ["READTHEDOCS"] = "True"

docs/epilog.rst

@@ -0,0 +1,3 @@
+
+.. _tcod-ecs: https://github.com/HexDecimal/python-tcod-ecs
+.. _Flecs: https://github.com/SanderMertens/flecs

docs/tutorial/index.rst

@@ -3,6 +3,12 @@ Tutorial
 
 .. include:: notice.rst
 
+.. note::
+    This a Python tutorial reliant on a Modern ECS implementation.
+    In this case `tcod-ecs`_ will be used.
+    Most other Python ECS libraries do not support entity relationships and arbitrary tags required by this tutorial.
+    If you wish to use this tutorial with another language you may need a Modern ECS implementation on par with `Flecs`_.
+
 .. toctree::
     :maxdepth: 1
     :glob: