Deprecated all in-repository examples

Also removed the `termcolor` dependency, which was only used by the
examples.

Author: avdstaaij

CHANGELOG.md

@@ -5,6 +5,7 @@ Compatible with GDMC-HTTP **>=1.0.0, <2.0.0** and Minecraft **1.20.2**.
 
 **Deprecations:**
 - Deprecated `lookup.py` and `minecraft_tools.getObtrusiveness`. See the documentation the reasons and for alternatives. Also removed example `visualize_map.py`, which heavily relied on `lookup.py`.
+- Deprecated all remaining in-repository examples. They have been replaced by the new [documentation website](https://gdpc.readthedocs.io).
 
 
 # 7.4.0

examples/README.md

@@ -0,0 +1,8 @@
+# The in-repository examples are deprecated!
+
+All examples in this directory are deprecated and will be removed in a future
+version of GDPC. They have been replaced by the new
+[documentation website](https://gdpc.readthedocs.io/en/stable/).
+
+The examples are longer maintained and may be incompatible with the latest
+version of GDPC.

examples/emerald_city.py

@@ -1,5 +1,19 @@
 #!/usr/bin/env python3
 
+# ==============================================================================
+#
+# THE EXAMPLES ARE DEPRECATED!
+#
+# All in-repository examples are deprecated and will be removed in a future
+# version of GDPC. They have been replaced by the new documentation website:
+# https://gdpc.readthedocs.io/en/stable/.
+#
+# The examples are longer maintained and may be incompatible with the latest
+# version of GDPC.
+#
+# ==============================================================================
+
+
 """
 NOTE: This file is an old example script. Although it is no longer
       comprehensive, and it does not use the most modern features or best

examples/quick_example.py

@@ -1,5 +1,19 @@
 #!/usr/bin/env python3
 
+# ==============================================================================
+#
+# THE EXAMPLES ARE DEPRECATED!
+#
+# All in-repository examples are deprecated and will be removed in a future
+# version of GDPC. They have been replaced by the new documentation website:
+# https://gdpc.readthedocs.io/en/stable/.
+#
+# The examples are longer maintained and may be incompatible with the latest
+# version of GDPC.
+#
+# ==============================================================================
+
+
 """The quick example from the README"""
 
 

examples/tutorials/1_hello_block.py

@@ -1,5 +1,19 @@
 #!/usr/bin/env python3
 
+# ==============================================================================
+#
+# THE EXAMPLES ARE DEPRECATED!
+#
+# All in-repository examples are deprecated and will be removed in a future
+# version of GDPC. They have been replaced by the new documentation website:
+# https://gdpc.readthedocs.io/en/stable/.
+#
+# The examples are longer maintained and may be incompatible with the latest
+# version of GDPC.
+#
+# ==============================================================================
+
+
 """
 Place and retrieve a single block in the world.
 """

examples/tutorials/2_vectors.py

@@ -1,5 +1,19 @@
 #!/usr/bin/env python3
 
+# ==============================================================================
+#
+# THE EXAMPLES ARE DEPRECATED!
+#
+# All in-repository examples are deprecated and will be removed in a future
+# version of GDPC. They have been replaced by the new documentation website:
+# https://gdpc.readthedocs.io/en/stable/.
+#
+# The examples are longer maintained and may be incompatible with the latest
+# version of GDPC.
+#
+# ==============================================================================
+
+
 """
 Use vector math and some of GDPC's various vector utilities.
 """

examples/tutorials/3_build_area.py

@@ -1,5 +1,19 @@
 #!/usr/bin/env python3
 
+# ==============================================================================
+#
+# THE EXAMPLES ARE DEPRECATED!
+#
+# All in-repository examples are deprecated and will be removed in a future
+# version of GDPC. They have been replaced by the new documentation website:
+# https://gdpc.readthedocs.io/en/stable/.
+#
+# The examples are longer maintained and may be incompatible with the latest
+# version of GDPC.
+#
+# ==============================================================================
+
+
 """
 Get the specified build area and use it to place a block inside the bounds.
 """

examples/tutorials/4_world_slice.py

@@ -1,5 +1,19 @@
 #!/usr/bin/env python3
 
+# ==============================================================================
+#
+# THE EXAMPLES ARE DEPRECATED!
+#
+# All in-repository examples are deprecated and will be removed in a future
+# version of GDPC. They have been replaced by the new documentation website:
+# https://gdpc.readthedocs.io/en/stable/.
+#
+# The examples are longer maintained and may be incompatible with the latest
+# version of GDPC.
+#
+# ==============================================================================
+
+
 """
 Load and use a world slice.
 """

examples/tutorials/5_geometry.py

@@ -1,5 +1,19 @@
 #!/usr/bin/env python3
 
+# ==============================================================================
+#
+# THE EXAMPLES ARE DEPRECATED!
+#
+# All in-repository examples are deprecated and will be removed in a future
+# version of GDPC. They have been replaced by the new documentation website:
+# https://gdpc.readthedocs.io/en/stable/.
+#
+# The examples are longer maintained and may be incompatible with the latest
+# version of GDPC.
+#
+# ==============================================================================
+
+
 """
 Use the geometry module to place geometrical regions of blocks.
 """

examples/tutorials/6_advanced_blocks.py

@@ -1,5 +1,19 @@
 #!/usr/bin/env python3
 
+# ==============================================================================
+#
+# THE EXAMPLES ARE DEPRECATED!
+#
+# All in-repository examples are deprecated and will be removed in a future
+# version of GDPC. They have been replaced by the new documentation website:
+# https://gdpc.readthedocs.io/en/stable/.
+#
+# The examples are longer maintained and may be incompatible with the latest
+# version of GDPC.
+#
+# ==============================================================================
+
+
 """
 Place blocks with block states and block entity data, and use block palettes.
 """