Fix issue with changelog no longer displayed (#186)

  - It was a problem with include-markdown directive,
    between doc examples and the 'real' include of the changelog;
    solved it by changing the syntax of the 'real' include.
  - Updated changelog
  - Bumped version number

Author: Laurent Franceschetti

CHANGELOG.md

@@ -4,6 +4,12 @@ All notable changes to this project will be documented in this file.
 
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/) and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## 1.0.5, 2023-10-31
+
+* Added: git.short_tag (#183)
+* Added: Mermaid diagrams in the documentation (Readthedocs)
+* Fixed: Changelog was no longer displayed (#186)
+
 ## 1.0.4, 2023-08-07
 
 * Fixed: Warning due to filter issue with mkdocs >= 1.5

webdoc/docs/advanced.md

@@ -21,7 +21,6 @@ To include external files within a page, you may use the
 
 ```jinja2
 ## Paragraph
-
 {% include 'snippet.md' %}
 ```
 

webdoc/docs/changelog.md

@@ -1,4 +1,4 @@
 
-{% 
+[% 
     include-markdown "../../CHANGELOG.md" 
-%}
+%]

webdoc/mkdocs.yml

@@ -52,7 +52,10 @@ plugins:
   # 1. a question of "boostrap" (avoid chicken and the egg issues)
   # 2. avoid interpreting the jinja2 code examples as instructions.
   - search
-  # - include-markdown
+  - include-markdown:
+      # This is changed so that real include doesn't interefere with examples
+      opening_tag: "[%"
+      closing_tag: "%]"
   - mermaid2