Document breaking change

Author: geographika

docs/HISTORY.rst

@@ -1,6 +1,29 @@
 Releases
 --------
 
+1.1.0 Coming Soon
++++++++++++++++++
+
++ **Breaking Change** - :ref:`create <api-create>` now creates an empty block by default.
+  Pass ``add_default=True`` to include the default MapServer parameters.
+
+1.0.1 31/05/2024
+++++++++++++++++
+
+Patch release and CI (Continuous Integration) updates.
+
+`Full changlog <https://github.com/geographika/mappyfile/compare/v1.0.1...v1.0.2>`__.
+
+1.0.1 25/04/2024
+++++++++++++++++
+
+Patch release.
+
++ `#206 <https://github.com/geographika/mappyfile/pull/206>`_ - Ensure findall works when properties are missing
+
+`Full changlog <https://github.com/geographika/mappyfile/compare/v1.0.0...v1.0.1>`__.
+
+
 1.0.0 28/09/2023
 ++++++++++++++++
 

docs/schemas.rst

@@ -43,11 +43,17 @@ If MapServer uses default values for an object, the `create` function can be use
 a new object using these defaults. For example to output a `MAP` object with default settings
 run the following code:
 
+.. note::
+
+    From mappyfile 1.1+ by default an empty ``MAP END`` object is created. 
+    The value ``add_defaults=True`` has to be passed to ``create`` to add in
+    the MapServer default settings.
+
 .. code-block:: python
 
     import mappyfile
 
-    m = mappyfile.create("map", version=8.0)
+    m = mappyfile.create("map", version=8.0, add_defaults=True)
     print(m)
     mappyfile.dumps(m)
 

run_local.ps1

@@ -15,4 +15,11 @@ flake8 .
 mypy mappyfile tests docs/examples --check-untyped-defs
 
 pytest --doctest-modules
-# pytest ./tests
+# pytest ./tests
+
+
+# docs
+
+sphinx-build -b html "./docs" "./_build" -W
+python -m http.server --directory=./_build 57921
+# http://localhost:57921