Add base content from mkdocs_template_rdeville

Add content of docs/ folder with the base content installed from the template
mkdocs_template_rdeville

docs/.gitlab-ci.yml

+### BEGIN MKDOCS TEMPLATE ###
+### WARNING, DO NOT UPDATE CONTENT BETWEEN MKDOCS TEMPLATE TAG !###
+### Modified content will be overwritten when updating.###
 ---
 # GLOBAL CONFIGURATION
 # =============================================================================
@@ -87,71 +90,17 @@ variables:
   # This could be shortened but gitlab-ci does not support bash variable substitution
   - |
     case ${CI_DEPLOY_TYPE} in
-      "DEV")
-        if [[ -n "${SSH_KNOWN_HOSTS_DEV}" ]];
-        then
-          export SSH_KNOWN_HOSTS="${SSH_KNOWN_HOSTS_DEV}"
-        fi
-        if [[ -n "${SSH_PRIVATE_KEY_DEV}" ]];
-        then
-          export SSH_PRIVATE_KEY="${SSH_PRIVATE_KEY_DEV}"
-        fi
-        if [[ -n "${ONLINE_DEST_DEV}" ]];
-        then
-          export ONLINE_DEST="${ONLINE_DEST_DEV}"
-        fi
-        if [[ -n "${RSYNC_DEST_DEV}" ]];
-        then
-          export RSYNC_DEST="${RSYNC_DEST_DEV}"
-        fi
-        if [[ -n "${RSYNC_BASE_PATH_DEV}" ]];
-        then
-          export RSYNC_BASE_PATH="${RSYNC_BASE_PATH_DEV}"
-        fi
+      "dev")
+        export RSYNC_DEST="${RSYNC_DEST}/dev/"
+        export ONLINE_DEST="${ONLINE_DEST}/dev/"
       ;;
-      "PRE_PROD")
-        if [[ -n "${SSH_KNOWN_HOSTS_PRE_PROD}" ]];
-        then
-          export SSH_KNOWN_HOSTS="${SSH_KNOWN_HOSTS_PRE_PROD}"
-        fi
-        if [[ -n "${SSH_PRIVATE_KEY_PRE_PROD}" ]];
-        then
-          export SSH_PRIVATE_KEY="${SSH_PRIVATE_KEY_PRE_PROD}"
-        fi
-        if [[ -n "${ONLINE_DEST_PRE_PROD}" ]];
-        then
-          export ONLINE_DEST="${ONLINE_DEST_PRE_PROD}"
-        fi
-        if [[ -n "${RSYNC_DEST_PRE_PROD}" ]];
-        then
-          export RSYNC_DEST="${RSYNC_DEST_PRE_PROD}"
-        fi
-        if [[ -n "${RSYNC_BASE_PATH_PRE_PROD}" ]];
-        then
-          export RSYNC_BASE_PATH="${RSYNC_BASE_PATH_PRE_PROD}"
-        fi
+      "pre_prod")
+        export RSYNC_DEST="${RSYNC_DEST}/pre_prod/"
+        export ONLINE_DEST="${ONLINE_DEST}/pre_prod/"
       ;;
-      "PROD")
-        if [[ -n "${SSH_KNOWN_HOSTS_PROD}" ]];
-        then
-          export SSH_KNOWN_HOSTS="${SSH_KNOWN_HOSTS_PROD}"
-        fi
-        if [[ -n "${SSH_PRIVATE_KEY_PROD}" ]];
-        then
-          export SSH_PRIVATE_KEY="${SSH_PRIVATE_KEY_PROD}"
-        fi
-        if [[ -n "${ONLINE_DEST_PROD}" ]];
-        then
-          export ONLINE_DEST="${ONLINE_DEST_PROD}"
-        fi
-        if [[ -n "${RSYNC_DEST_PROD}" ]];
-        then
-          export RSYNC_DEST="${RSYNC_DEST_PROD}"
-        fi
-        if [[ -n "${RSYNC_BASE_PATH_PROD}" ]];
-        then
-          export RSYNC_BASE_PATH="${RSYNC_BASE_PATH_PROD}"
-        fi
+      "pre_prod")
+        export RSYNC_DEST="${RSYNC_DEST}/"
+        export ONLINE_DEST="${ONLINE_DEST}/"
       ;;
       *)
         echo -e "\e[31mERROR - Variable \`CI_DEPLOY_TYPE\` is not defined !"
@@ -173,17 +122,17 @@ variables:
 .rules_dev: &rules_dev
   if: *rules_regexp_dev
   variables:
-    CI_DEPLOY_TYPE: "DEV"
+    CI_DEPLOY_TYPE: "dev"
 
 .rules_pre_prod: &rules_pre_prod
   if: *rules_regexp_pre_prod
   variables:
-    CI_DEPLOY_TYPE: "PRE_PROD"
+    CI_DEPLOY_TYPE: "pre_prod"
 
 .rules_prod: &rules_prod
   if: *rules_regexp_prod
   variables:
-    CI_DEPLOY_TYPE: "PROD"
+    CI_DEPLOY_TYPE: "prod"
 
 # Tag anchors
 # -----------------------------------------------------------------------------
@@ -267,25 +216,25 @@ script_pre_test_ensure_variable: &script_pre_test_ensure_variable
     - |
       if [[ -z "${SSH_KNOWN_HOSTS}" ]]
       then
-        echo -e "\e[31mERROR - Variable \`SSH_KNOWN_HOSTS_${CI_DEPLOY_TYPE})\` is not defined !"
+        echo -e "\e[31mERROR - Variable \`SSH_KNOWN_HOSTS)\` is not defined !"
         export ERROR="true"
       fi
     - |
       if [[ -z "${SSH_PRIVATE_KEY}" ]]
       then
-        echo -e "\e[31mERROR - Variable \`SSH_PRIVATE_KEY_${CI_DEPLOY_TYPE}\` is not defined !"
+        echo -e "\e[31mERROR - Variable \`SSH_PRIVATE_KEY\` is not defined !"
         export ERROR="true"
       fi
     - |
       if [[ -z "${ONLINE_DEST}" ]]
       then
-        echo -e "\e[31mERROR - Variable \`ONLINE_DEST_${CI_DEPLOY_TYPE}\` is not defined !"
+        echo -e "\e[31mERROR - Variable \`ONLINE_DEST\` is not defined !"
         export ERROR="true"
       fi
     - |
       if [[ -z "${RSYNC_DEST}" ]]
       then
-        echo -e "\e[31mERROR - Variable \`RSYNC_DEST_${CI_DEPLOY_TYPE}\` is not defined !"
+        echo -e "\e[31mERROR - Variable \`RSYNC_DEST\` is not defined !"
         export ERROR="true"
       fi
     - |
@@ -313,8 +262,6 @@ test_build_local:
     - pip3 install -r requirements.docs.txt
     # Build local documentation
     - mkdocs build -f mkdocs.local.yml -d site_local
-    # If everything went right, remove build site
-    - rm -rf site_local
   rules:
     - exists:
       - mkdocs.local.yaml
@@ -330,9 +277,7 @@ test_build:
     # Install python test requirements
     - pip3 install -r requirements.docs.txt
     # Build local documentation
-    - mkdocs build -d site_monorepo
-    # If everything went right, remove build site
-    - rm -rf site_monorepo
+    - mkdocs build -d site
 
 # Jobs in build stage
 # -----------------------------------------------------------------------------
@@ -371,7 +316,7 @@ script_deploy_html: &script_deploy_html
     - export LAST_TAG="${LAST_TAG%.*}"
     - |
       case "${CI_DEPLOY_TYPE}" in
-        "DEV")
+        "dev")
           if [[ -n "${RSYNC_BASE_PATH}" ]];
           then
             export PROJECT_PATH="/${CI_COMMIT_BRANCH}/${RSYNC_BASE_PATH}/";
@@ -379,7 +324,7 @@ script_deploy_html: &script_deploy_html
             export PROJECT_PATH="/${CI_COMMIT_BRANCH}/"
           fi
           ;;
-        "PRE_PROD")
+        "pre_prod")
           if [[ -n "${RSYNC_BASE_PATH}" ]];
           then
             export PROJECT_PATH="/${CI_COMMIT_BRANCH}/${RSYNC_BASE_PATH}/";
@@ -387,7 +332,7 @@ script_deploy_html: &script_deploy_html
             export PROJECT_PATH="/${CI_COMMIT_BRANCH}/"
           fi
           ;;
-        "PROD")
+        "prod")
           if [[ -n "${RSYNC_BASE_PATH}" ]];
           then
             export PROJECT_PATH="/${RSYNC_BASE_PATH}/";
@@ -459,12 +404,12 @@ inform_triggers_variables:
       if [[ -z "${MAIN_PROJECT}" ]]
       then
        echo -e "\e[32m
-          INFO - To trigger a main repo documentation CI, you can set \n
-          INFO - variable \`MAIN_PROJECT\`. Otherwise, you have nothing\n
-          INFO - to do. If the CI you want to run is not at the root of\n
-          INFO - the repo defined by variable \`MAIN_PROJECT\`. You can\n
-          INFO - set the variable \`MAIN_PROJECT_CI_PATH\` which define\n
-          INFO - the path to the file \`gitlab-ci.yaml\` to be run in  \n
+          INFO - To trigger a main repo documentation CI, you can set \\n
+          INFO - variable \`MAIN_PROJECT\`. Otherwise, you have nothing\\n
+          INFO - to do. If the CI you want to run is not at the root of\\n
+          INFO - the repo defined by variable \`MAIN_PROJECT\`. You can\\n
+          INFO - set the variable \`MAIN_PROJECT_CI_PATH\` which define\\n
+          INFO - the path to the file \`gitlab-ci.yaml\` to be run in  \\n
           INFO - the \`MAIN_PROJECT\`."
       fi
   rules:
@@ -476,3 +421,4 @@ inform_triggers_variables:
 # VIM MODELINE
 # vim: fdm=indent
 # *****************************************************************************
+### END MKDOCS TEMPLATE ###

docs/_data/schema/repo.schema.yaml

+### BEGIN MKDOCS TEMPLATE ###
+### WARNING, DO NOT UPDATE CONTENT BETWEEN MKDOCS TEMPLATE TAG !###
+### Modified content will be overwritten when updating.###
 # Schema to validate yaml files describing repo information
 type: map
 mapping:
@@ -40,3 +43,4 @@ mapping:
                 required: true
                 example: >-
                   Key `name` and `mail` are string and are required.
+### END MKDOCS TEMPLATE ###

docs/_data/schema/subrepo.schema.yaml

+### BEGIN MKDOCS TEMPLATE ###
+### WARNING, DO NOT UPDATE CONTENT BETWEEN MKDOCS TEMPLATE TAG !###
+### Modified content will be overwritten when updating.###
 # Schema to validate subrepo.yml
 schema;subrepo_map:
   type: map
@@ -97,3 +100,4 @@ required: true
 mapping:
   subrepo:
     include: subrepo_map
+### END MKDOCS TEMPLATE ###

docs/_data/schema/vars.schema.yaml

+### BEGIN MKDOCS TEMPLATE ###
+### WARNING, DO NOT UPDATE CONTENT BETWEEN MKDOCS TEMPLATE TAG !###
+### Modified content will be overwritten when updating.###
 # Schema to validate vars.yml
 type: map
 mapping:
@@ -84,4 +87,5 @@ mapping:
         type: url
         required: true
         example: >-
-          Key `url` is a URL and is required
+          Key `url` is a URL and is required
\ No newline at end of file
+### END MKDOCS TEMPLATE ###

docs/_data/template/repo.tpl.yaml

+### BEGIN MKDOCS TEMPLATE ###
+### WARNING, DO NOT UPDATE CONTENT BETWEEN MKDOCS TEMPLATE TAG !###
+### Modified content will be overwritten when updating.###
 # Repo information
 # ===========================================================================
 # First key MUST be the "slug" of the repo based on the remote, i.e. if remote
@@ -42,4 +45,5 @@ repo_name:
   # added to the license file in `docs/about/license.md`
   maintainers:
     - name: "Firstname Lastname"
-      mail: "mail@domain.tld"
+      mail: "mail@domain.tld"
\ No newline at end of file
+### END MKDOCS TEMPLATE ###

docs/_data/template/subrepo.tpl.yaml

+### BEGIN MKDOCS TEMPLATE ###
+### WARNING, DO NOT UPDATE CONTENT BETWEEN MKDOCS TEMPLATE TAG !###
+### Modified content will be overwritten when updating.###
 # Subrepo Information
 # ---------------------------------------------------------------------------
 # Dictionnary storing location of subrepo to be included in the main repo
@@ -71,3 +74,4 @@ subrepo:
   #     - Direnv Template: /my_program/direnv_template/
   #     - Mkdocs Template: /my_program/mkdocs_template/
   # ```
+### END MKDOCS TEMPLATE ###

docs/_data/template/vars.tpl.yaml

+### BEGIN MKDOCS TEMPLATE ###
+### WARNING, DO NOT UPDATE CONTENT BETWEEN MKDOCS TEMPLATE TAG !###
+### Modified content will be overwritten when updating.###
 # Extra Data Information & Customization
 # ===========================================================================
 # Dictionnary storing variables to be used as "Jinja2" variables within
@@ -89,3 +92,4 @@ git_platform:
   # URL of the platform you use, to be able to set `repo_url` for mkdocs
   # configuration.
   url: "https://framagit.org/"
+### END MKDOCS TEMPLATE ###

docs/_data/vars.yaml

 ### BEGIN MKDOCS TEMPLATE ###
 ### WARNING, DO NOT UPDATE CONTENT BETWEEN MKDOCS TEMPLATE TAG !###
 ### Modified content will be overwritten when updating.###
-
 # Extra Data Information & Customization
 # ===========================================================================
 # Dictionnary storing variables to be used as "Jinja2" variables within
@@ -69,7 +68,7 @@
 # The base url of your site, e.g. if you are using multiple nested
 # documentation build with monorepo, you might want to share the same base URL
 # for all your repo, then build link from the repo["url_slug_with_namespace"].
-#site_url: "https://my_site.tld"
+site_base_url: "https://docs.romaindeville.fr"
 
 
 # Git platform
@@ -93,5 +92,4 @@ git_platform:
   # URL of the platform you use, to be able to set `repo_url` for mkdocs
   # configuration.
   url: "https://framagit.org/"
-
 ### END MKDOCS TEMPLATE ###

docs/about/code_of_conduct.md

+{% set curr_repo=subs("mkdocs_template") %}
+
+<!-- BEGIN MKDOCS TEMPLATE -->
+<!--
+WARNING, DO NOT UPDATE CONTENT BETWEEN MKDOCS TEMPLATE TAG !
+Modified content will be overwritten when updating
+-->
+
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, religion, or sexual identity
+and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the
+  overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official e-mail address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at:
+{% for i_maintainer in curr_repo.maintainers %}
+  - **[📧 {{ i_maintainer.name }} <{{ i_maintainer.mail }}>](mailto:{{ i_maintainer.mail }})**
+{% endfor %}
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series
+of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or
+permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior,  harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within
+the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the
+[Contributor Covenant](https://www.contributor-covenant.org),
+version 2.0, available at
+[https://www.contributor-covenant.org/version/2/0/code_of_conduct.html](https://www.contributor-covenant.org/version/2/0/code_of_conduct.html).
+
+Community Impact Guidelines were inspired by
+[Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+For answers to common questions about this code of conduct, see the FAQ at
+[https://www.contributor-covenant.org/faq](https://www.contributor-covenant.org/faq).
+Translations are available at
+[https://www.contributor-covenant.org/translations](https://www.contributor-covenant.org/translations).
+
+<!-- END MKDOCS TEMPLATE -->

docs/about/contributing.md

+{% set curr_repo=subs("mkdocs_template") %}
+
+<!-- BEGIN MKDOCS TEMPLATE -->
+<!--
+WARNING, DO NOT UPDATE CONTENT BETWEEN MKDOCS TEMPLATE TAG !
+Modified content will be overwritten when updating
+-->
+
+# Contributing
+
+This project welcomes contributions from developers and users in the open source
+community. Contributions can be made in a number of ways, a few examples are :
+
+  * Code patch via pull requests
+  * Documentation improvements
+  * Bug reports and patch reviews
+  * Proposition of new features
+  * etc.
+
+## Reporting an Issue
+
+Please include as much details as you can when reporting an issue in the [issue
+trackers][issue_tracker]. If the problem is visual (for instance, wrong
+documentation rendering) please add a screenshot.
+
+[issue_tracker]: {{ git_platform.url }}{{ curr_repo.git_slug_with_namespace }}/-/issues
+
+## Submitting Pull Requests
+
+Once you are happy with your changes or you are ready for some feedback, push it
+to your fork and send a pull request. For a change to be accepted it will most
+likely need to have tests and documentation if it is a new feature.
+
+For more information, you can refers to the main [developers
+guides][developers_guides] which is the common resources I use for all
+my projects. There you will find:
+
+  * [Syntax Guide][syntax_guide], which describe syntax guidelines per language
+    to follow if you want to contribute.
+  * [Contributing workflow][contributing_workflow], which provide an example
+   of the workflow I used for the development.
+
+[developers_guides]: {{ site_base_url }}/dev_guides/index.html
+[syntax_guide]: {{ site_base_url }}/dev_guides/style_guides/index.html
+[contributing_workflow]: {{ site_base_url }}/dev_guides/contributing_workflow.html
+
+## Community
+
+Finally, every member of the community should follow this [Code of
+conduct][code_of_conduct].
+
+[code_of_conduct]: code_of_conduct.md
+
+<!-- END MKDOCS TEMPLATE -->

docs/about/data_privacy.md

+<!-- BEGIN MKDOCS TEMPLATE -->
+<!-- WARNING, DO NOT UPDATE CONTENT BETWEEN MKDOCS TEMPLATE TAG !-->
+<!-- Modified content will be overwritten when updating.-->
 # Data Privacy
 
 In itself, [Material for MkDocs][mkdocs_material] theme use for this
@@ -7,4 +10,20 @@ Data Protection Regulation (GDPR).
 Moreover, no third-party services are used in this documentation, i.e. it does
 not use google-fonts, google-analytics, neither Disqus.
 
+Any rendering tools, such as [mermaid][mermaid], [tablesort][tablesort],
+[lightgallery][lightgallery], [MathJax][MathJax], etc. are served locally without
+using CDN or call to external website. The aims are to :
+
+- Render the documentation with stable tools (i.e. documentation may not be
+  using latest version of previously mentionned tools),
+- Avoid useless network requests to external CDN,
+- Render the documentation even if the user (like me) has web browser add-on
+  which filter javascript such as [uMatrix][uMatrix].
+
 [mkdocs_material]: https://squidfunk.github.io/mkdocs-material/data-privacy/
+[mermaid]: https://mermaid-js.github.io/mermaid/#/)
+[tablesort]: https://cdnjs.cloudflare.com/ajax/libs/tablesort/5.2.1/tablesort.min.js
+[lightgallery]: https://sachinchoolur.github.io/lightgallery.js/
+[MathJax]: https://www.mathjax.org/
+[uMatrix]: https://github.com/gorhill/uMatrix
+<!-- END MKDOCS TEMPLATE -->

docs/about/index.md

 <!-- BEGIN MKDOCS TEMPLATE -->
+<!-- WARNING, DO NOT UPDATE CONTENT BETWEEN MKDOCS TEMPLATE TAG !-->
+<!-- Modified content will be overwritten when updating.-->
 # About
 
 In this part of the documentation, you can consult:
 
+  - [Code of Conduct](code_of_conduct.md)
+  - [Contributing](contributing.md)
   - [Data Privacy](data_privacy.md)
+  - [License](license.md)
+  - [Release Notes](release_notes.md)
 <!-- END MKDOCS TEMPLATE -->

docs/about/license.md

+{% set curr_repo=subs("mkdocs_template") %}
+
+<!-- BEGIN MKDOCS TEMPLATE -->
+<!--
+WARNING, DO NOT UPDATE CONTENT BETWEEN MKDOCS TEMPLATE TAG !
+Modified content will be overwritten when updating
+-->
+
+# Licenses
+
+<!-- END MKDOCS TEMPLATE -->
+
+Software is under double licensing:
+
+ - [MIT License](#mit-license)
+ - [Beer-Ware License](#the-beer-ware-license)
+
+## MIT License
+
+Copyright (c) 2020
+
+{% for i_maintainer in curr_repo.maintainers %}
+  - [{{ i_maintainer.name }}](mailto:{{ i_maintainer.mail }})
+{% endfor %}
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+
+## The Beer-Ware License
+
+Following maintainers worked on this project:
+
+{% for i_maintainer in curr_repo.maintainers %}
+  - [{{ i_maintainer.name }}](mailto:{{ i_maintainer.mail }})
+{% endfor %}
+
+As long as you retain this notice you can do whatever you want with this stuff.
+
+If we meet some day, and you think this stuff is worth it, you can buy us a
+beer in return.

docs/about/release_notes.md

+<!-- BEGIN MKDOCS TEMPLATE -->
+<!--
+WARNING, DO NOT UPDATE CONTENT BETWEEN MKDOCS TEMPLATE TAG !
+Modified content will be overwritten when updating
+-->
+
+# Release Notes
+
+<!-- END MKDOCS TEMPLATE -->
+

docs/assets/twemoji/svg/1f004.svg

+<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 36 36"><path fill="#E6E7E8" d="M32 32c0 2.209-1.791 4-4 4H8c-2.209 0-4-1.791-4-4V4c0-2.209 1.791-4 4-4h20c2.209 0 4 1.791 4 4v28z"/><path fill="#BE1931" d="M8.397 11.891c.53 0 .996.078 1.392.232.244.066.453.143.63.231.796-.044 1.612-.122 2.453-.231 1.104-.134 2.463-.297 4.076-.497V9.307c0-1.613-.188-2.948-.563-4.01-.155-.332-.233-.552-.233-.662 0-.331.133-.498.398-.498.706 0 1.359.089 1.954.266.686.198 1.028.453 1.028.761 0 .111-.042.342-.134.696-.265.685-.395 1.955-.395 3.811v1.723c1.299-.132 2.723-.276 4.271-.43.706-.045 1.381-.166 2.023-.366.463-.088.739-.132.83-.132.264 0 .837.222 1.72.662.928.553 1.394.984 1.394 1.293 0 .242-.12.486-.362.729-.819.881-1.408 1.809-1.759 2.782l-.798 1.691c-.13.329-.276.583-.426.76l.128.067c.508.311.761.586.761.829 0 .198-.183.309-.56.332-1.699 0-3.236.088-4.606.266l-2.614.196-.034 4.442c0 2.009-.069 3.62-.198 4.838-.133 1.368-.333 2.341-.598 2.914-.245.488-.445.733-.598.733-.089 0-.232-.266-.431-.798-.132-.617-.198-1.687-.198-3.214v-8.749l-1.789.167c-1.194.111-2.111.168-2.75.168-.266 0-.488-.024-.664-.069-.044.2-.11.376-.198.533-.133.287-.277.43-.432.43-.198 0-.385-.154-.562-.465-.287-.438-.442-.892-.464-1.358l-.398-2.585c-.155-1.348-.332-2.286-.531-2.818-.111-.551-.409-1.081-.894-1.59-.177-.11-.266-.186-.266-.23 0-.354.133-.531.397-.531zm3.347 7.221c1.812-.085 3.545-.196 5.203-.328v-6.132c-1.702.199-3.347.464-4.937.796-.31.111-.597.188-.862.232 0 .265.022.53.067.793.265 2.013.441 3.561.529 4.639zm7.259-6.69v6.163c.728-.087 1.435-.179 2.119-.265 1.326-.178 2.286-.286 2.879-.331.048-.11.103-.232.168-.363.199-.641.463-1.646.798-3.016.264-1.084.394-1.768.394-2.056 0-.353-.339-.529-1.024-.529-1.041 0-2.696.121-4.973.363-.13-.001-.254.012-.361.034z"/></svg>
\ No newline at end of file

docs/assets/twemoji/svg/1f0cf.svg

+<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 36 36"><path fill="#E6E7E8" d="M32 32c0 2.209-1.791 4-4 4H8c-2.209 0-4-1.791-4-4V4c0-2.209 1.791-4 4-4h20c2.209 0 4 1.791 4 4v28z"/><path fill="#DD2E44" d="M11 7c-2.519 0-4.583 1.87-4.929 4.293C6.802 10.503 7.839 10 9 10c2.209 0 4 1.791 4 4 0 2 1.497 2.198.707 2.929C16.13 16.583 16 14.519 16 12c0-2.761-2.239-5-5-5z"/><path fill="#55ACEE" d="M23 14c0-2.209 1.791-4 4-4 1.161 0 2.198.503 2.929 1.293C29.583 8.87 27.52 7 25 7c-2.762 0-5 2.239-5 5 0 2.519-.131 4.583 2.293 4.929C21.503 16.198 23 16 23 14z"/><path fill="#FFAC33" d="M14 12c0-4.971 4-9 4-9s4 4.029 4 9-1.791 9-4 9-4-4.029-4-9z"/><path fill="#553788" d="M11.707 21.071C12.497 21.802 13 22.839 13 24c0 2.209-1.791 4-4 4-1.161 0-2.198-.503-2.929-1.293C6.417 29.131 8.481 31 11 31c2.761 0 5-2.238 5-5 0-2.52-1.87-4.583-4.293-4.929zM27 28c-2.209 0-4-1.791-4-4 0-1.161.503-2.198 1.293-2.929C21.869 21.417 20 23.48 20 26c0 2.762 2.238 5 5 5 2.52 0 4.583-1.869 4.929-4.293C29.198 27.497 28.161 28 27 28z"/><path fill="#9266CC" d="M14 24c0 4.971 3 9 4 9s4-4.029 4-9c0-.874-.055-1.719-.159-2.519C21.357 17.737 19.82 15 18 15c-1.82 0-3.357 2.737-3.841 6.481-.104.8-.159 1.645-.159 2.519z"/><path fill="#EDBB9F" d="M13 17c0-3.866 3-4 5-4s5 .134 5 4c0 3.865-2.238 7-5 7-2.761 0-5-3.135-5-7z"/><circle fill="#662113" cx="16" cy="17" r="1"/><circle fill="#662113" cx="20" cy="17" r="1"/><path fill="#662113" d="M18 22c1.104 0 2-.896 2-2h-4c0 1.104.896 2 2 2z"/><circle fill="#A0041E" cx="6" cy="11" r="1"/><circle fill="#269" cx="30" cy="11" r="1"/><circle fill="#DD2E44" cx="18" cy="3" r="1"/></svg>
\ No newline at end of file

docs/assets/twemoji/svg/1f170.svg

+<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 36 36"><path fill="#DD2E44" d="M36 32c0 2.209-1.791 4-4 4H4c-2.209 0-4-1.791-4-4V4c0-2.209 1.791-4 4-4h28c2.209 0 4 1.791 4 4v28z"/><path fill="#FFF" d="M14.747 9.125c.527-1.426 1.736-2.573 3.317-2.573 1.643 0 2.792 1.085 3.318 2.573l6.077 16.867c.186.496.248.931.248 1.147 0 1.209-.992 2.046-2.139 2.046-1.303 0-1.954-.682-2.264-1.611l-.931-2.915h-8.62l-.93 2.884c-.31.961-.961 1.642-2.232 1.642-1.24 0-2.294-.93-2.294-2.17 0-.496.155-.868.217-1.023l6.233-16.867zm.34 11.256h5.891l-2.883-8.992h-.062l-2.946 8.992z"/></svg>
\ No newline at end of file

docs/assets/twemoji/svg/1f171.svg

+<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 36 36"><path fill="#DD2E44" d="M36 32c0 2.209-1.791 4-4 4H4c-2.209 0-4-1.791-4-4V4c0-2.209 1.791-4 4-4h28c2.209 0 4 1.791 4 4v28z"/><path fill="#FFF" d="M10.498 9.249c0-1.488 1.023-2.325 2.449-2.325H18.9c3.224 0 5.83 2.17 5.83 5.457 0 2.17-.9 3.628-2.885 4.558v.062c2.637.372 4.713 2.573 4.713 5.271 0 4.372-2.914 6.729-7.193 6.729h-6.386c-1.427 0-2.481-.899-2.481-2.356V9.249zm4.651 6.418h2.419c1.519 0 2.511-.899 2.511-2.45 0-1.457-1.147-2.201-2.511-2.201h-2.419v4.651zm0 9.24h3.659c1.674 0 2.915-.961 2.915-2.697 0-1.458-1.117-2.45-3.287-2.45h-3.287v5.147z"/></svg>
\ No newline at end of file

docs/assets/twemoji/svg/1f17e.svg

+<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 36 36"><path fill="#DD2E44" d="M36 32c0 2.209-1.791 4-4 4H4c-2.209 0-4-1.791-4-4V4c0-2.209 1.791-4 4-4h28c2.209 0 4 1.791 4 4v28z"/><path fill="#FFF" d="M6.993 18.001c0-6.656 4.48-11.776 11.007-11.776 6.432 0 11.008 5.28 11.008 11.776 0 6.623-4.449 11.774-11.008 11.774-6.496 0-11.007-5.151-11.007-11.774zm17.023 0c0-3.872-2.016-7.36-6.016-7.36s-6.015 3.488-6.015 7.36c0 3.903 1.952 7.359 6.015 7.359 4.065 0 6.016-3.456 6.016-7.359z"/></svg>
\ No newline at end of file

docs/assets/twemoji/svg/1f17f.svg

+<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 36 36"><path fill="#269" d="M36 32c0 2.209-1.791 4-4 4H4c-2.209 0-4-1.791-4-4V4c0-2.209 1.791-4 4-4h28c2.209 0 4 1.791 4 4v28z"/><path fill="#FFF" d="M11 9.496C11 7.992 11.896 7 13.496 7h5.665c4.703 0 8.191 2.944 8.191 7.52 0 4.67-3.617 7.48-8 7.48H16v5.479c0 1.6-1.024 2.496-2.4 2.496s-2.6-.897-2.6-2.496V9.496zM16 18h3.062c2.018 0 3.297-1.465 3.297-3.385 0-1.92-1.279-3.392-3.297-3.392H16V18z"/></svg>
\ No newline at end of file