Install base documentation from template

Use basic mkdocs_template to setup base mkdocs documentation

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
+# =============================================================================
+# YAML Anchors
+# -----------------------------------------------------------------------------
+# This CI file haevily make use of YAML anchors for multiple reasons:
+#   - Avoid writing twice the same block of codes
+#   - Resuse block of codes
+#   - Make the CI more generic and easily extensible or modifiable
+# See https://docs.gitlab.com/ee/ci/yaml/README.html#anchors
+
+# Define base workflow
+# https://docs.gitlab.com/ee/ci/yaml/README.html#workflow
+workflow:
+  rules:
+    # Do not run CI when commit title have
+    # WIP, NO-CI or 🚧 (gitmoji for "work in progress", aka :construction:)
+    - if: |
+        $CI_COMMIT_TITLE =~ /.*WIP.*/ ||
+        $CI_COMMIT_TITLE =~ /.*NO-CI.*/ ||
+        $CI_COMMIT_TITLE =~ /.*🚧.*/
+      when: never
+    # Run the CI otherwise (depending on `only/except` key per jobs)
+    - when: always
+
+# Stages jobs will pass through with anchors to avoid updating stage in multiple
+# place within this file. Now renaming a stage can be done directly after the
+# anchor name below.
+# https://docs.gitlab.com/ee/ci/yaml/README.html#stage
+stages:
+  - &pre_test pre_test
+  - &test test
+  - &build build
+  - &deploy deploy
+  - &post_deploy post_deploy
+
+# Global variables shared for all jobs
+# https://docs.gitlab.com/ee/ci/yaml/README.html#variables
+variables:
+  PIP_CACHE_DIR: "${CI_PROJECT_DIR}/.cache/pip"
+
+# Images anchors
+# -----------------------------------------------------------------------------
+# https://docs.gitlab.com/ee/ci/yaml/README.html#image
+# Basic docker image -> docker:latest image
+.image_docker: &image_docker
+  image: docker:latest
+
+# Before scripts anchors
+# -----------------------------------------------------------------------------
+# https://docs.gitlab.com/ee/ci/yaml/README.html#before_script
+.before_script_python_dependencies: &before_script_python_dependencies
+  # Add python dependencies
+  - apk update
+  # Install base package required for mkdocs builds
+  - apk add --no-cache --update-cache
+      build-base
+      python3-dev
+      py3-pip
+      py3-virtualenv
+      bash
+      git
+      gcc
+      musl-dev
+      jpeg-dev
+      zlib-dev
+      libffi-dev
+      cairo-dev
+      pango-dev
+      gdk-pixbuf
+      jpeg-dev
+      zlib-dev
+      freetype-dev
+      lcms2-dev
+      openjpeg-dev
+      tiff-dev
+      tk-dev
+      tcl-dev
+      harfbuzz-dev
+      fribidi-dev
+      chromium
+  # Create virtual environment
+  - virtualenv .venv
+  # Activate virtual environment
+  - source .venv/bin/activate
+
+.before_script_prepare_deployment: &before_script_prepare_deployment
+  # Add rsync dependencies
+  - apk update
+  - apk add --no-cache --update-cache
+      rsync
+      git
+  # Ensure ssh configuration folder exists
+  - mkdir -p ~/.ssh
+  # Ensure permission on this folder are right
+  - chmod 700 ~/.ssh
+  # Trust the perso LIRIS website
+  - echo "${SSH_KNOWN_HOSTS}" > ~/.ssh/known_hosts
+  # Ensure permission on the previously written file are right
+  - chmod 600 ~/.ssh/known_hosts
+  # Start the SSH agent
+  - eval $(ssh-agent -s)
+  # Add the private SSH key to be able to connect to the perso LIRIS website
+  - echo "${SSH_PRIVATE_KEY}" | tr -d '' | ssh-add -
+
+.before_script_export_variable: &before_script_export_variable
+  # Update values of some variables depending on the CI_DEPLOY_TYPE
+  # 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
+      ;;
+      "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
+      ;;
+      "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
+      ;;
+      *)
+        echo -e "ERROR - Variable \`CI_DEPLOY_TYPE\` is not defined !"
+        return 1
+      ;;
+    esac
+
+# Only anchors
+# -----------------------------------------------------------------------------
+# https://docs.gitlab.com/ee/ci/yaml/README.html#only
+# List all names of refs that can be used with key (only|except):refs using
+# anchors to avoid having to modify multiple times. Refs are:
+# - Branches names based on git flow: https://danielkummer.github.io/git-flow-cheatsheet/
+# - merge_requests (https://docs.gitlab.com/ee/ci/yaml/README.html#onlyexcept-basic)
+# - tags (https://docs.gitlab.com/ee/ci/yaml/README.html#onlyexcept-basic)
+.refs_names:
+  - &ref_release /release-*/
+  - &ref_feature /feature-*/
+  - &ref_hotfix /hotfix-*/
+  - &ref_bugfix /bugfix-*/
+  - &ref_develop develop
+  - &ref_master master
+  - &ref_merge_requests merge_requests
+  - &ref_tags tags
+
+# Specify on which branch, tags or on merge_requests CI should be done.
+# Jobs under only_dev anchor will be run if branch name are compliant with git
+# flow branch which are not `develop` neither `master` and will be run on
+# merge_request
+.only_dev: &only_dev
+  only:
+    refs:
+      -  *ref_release
+      -  *ref_feature
+      -  *ref_hotfix
+      -  *ref_bugfix
+      -  *ref_merge_requests
+
+# Jobs under only_pre_prod anchor will be run on `develop` (i.e. pre-release)
+# and `master` (release) branch.
+.only_pre_prod: &only_pre_prod
+  only:
+    refs:
+      - *ref_develop
+      - *ref_master
+
+# Jobs under only_prod anchor will be run on tagged commit.
+.only_prod: &only_prod
+  only:
+    refs:
+      - *ref_tags
+
+# Jobs under only_trigger anchor will be run on `develop` (i.e. pre-release)
+# `master` (release) branch and tagged commit.
+.only_trigger: &only_trigger
+  only:
+    refs:
+      - *ref_develop
+      - *ref_master
+      - *ref_tags
+
+# Tag anchors
+# -----------------------------------------------------------------------------
+# https://docs.gitlab.com/ee/ci/yaml/README.html#tag
+# Run jobs in regular docker
+.tag_docker: &tag_docker
+  tags:
+    - docker
+
+# Stages anchors
+# -----------------------------------------------------------------------------
+# https://docs.gitlab.com/ee/ci/yaml/README.html#stage
+# This can be seen as overbloated while overuse of YAML anchors, but the
+# advantage is that if we rename a stage, we will just need to rename it at the
+# start of this CI.
+.stage_pre_test: &stage_pre_test
+  stage: *pre_test
+
+.stage_test: &stage_test
+  stage: *test
+
+.stage_build: &stage_build
+  stage: *build
+
+.stage_deploy: &stage_deploy
+  stage: *deploy
+
+.stage_post_deploy: &stage_post_deploy
+  stage: *post_deploy
+
+# Cache anchors
+# -----------------------------------------------------------------------------
+# https://docs.gitlab.com/ee/ci/yaml/README.html#cache
+# Setup a global cache to avoid having to reinstall pip and package dependencies
+# every time.
+# **REMARK** For this to work, runners must be on the same server and docker
+# executor must mount /cache
+.cache_python: &cache_python
+  cache:
+    # Cache dependencies shared within the same branche
+    # https://docs.gitlab.com/ee/ci/yaml/README.html#cachekey
+    key: "$CI_COMMIT_REF_NAME"
+    # Let us cache python dependencies
+    # https://docs.gitlab.com/ee/ci/caching/#caching-python-dependencies
+    paths:
+      - .cache/pip
+      - .venv/
+    # Save cache all the time, even if jobs failed
+    # https://docs.gitlab.com/ee/ci/yaml/README.html#cachewhen
+    when: always
+
+.cache_python_pull: &cache_python_pull
+  cache:
+    # Cache dependencies shared across all branches but separated by jobs
+    # https://docs.gitlab.com/ee/ci/yaml/README.html#cachekey
+    key: "$CI_COMMIT_REF_NAME"
+    # Let us cache python dependencies
+    # https://docs.gitlab.com/ee/ci/caching/#caching-python-dependencies
+    paths:
+      - .cache/pip
+      - .venv/
+    # Setup policy to only pull python cache when we know jobs does not update
+    # content of python cache.
+    # https://docs.gitlab.com/ee/ci/yaml/README.html#cachepolicy
+    policy: pull
+
+# =============================================================================
+# CI JOBS
+# =============================================================================
+# Jobs in pre_test stage
+# -----------------------------------------------------------------------------
+# Template jobs script to ensure required variables are sets.
+.script_pre_test_ensure_variable: &script_pre_test_ensure_variable
+  <<: *tag_docker
+  <<: *image_docker
+  <<: *stage_pre_test
+  before_script:
+    - *before_script_export_variable
+  script:
+    - export ERROR="false"
+    - |
+      if [[ -z "${SSH_KNOWN_HOSTS}" ]]
+      then
+        echo -e "ERROR - Variable \`SSH_KNOWN_HOSTS_${CI_DEPLOY_TYPE})\` is not defined !"
+        export ERROR="true"
+      fi
+    - |
+      if [[ -z "${SSH_PRIVATE_KEY}" ]]
+      then
+        echo -e "ERROR - Variable \`SSH_PRIVATE_KEY_${CI_DEPLOY_TYPE}\` is not defined !"
+        export ERROR="true"
+      fi
+    - |
+      if [[ -z "${ONLINE_DEST}" ]]
+      then
+        echo -e "ERROR - Variable \`ONLINE_DEST_${CI_DEPLOY_TYPE}\` is not defined !"
+        export ERROR="true"
+      fi
+    - |
+      if [[ -z "${RSYNC_DEST}" ]]
+      then
+        echo -e "ERROR - Variable \`RSYNC_DEST_${CI_DEPLOY_TYPE}\` is not defined !"
+        export ERROR="true"
+      fi
+    - |
+      if [[ "${ERROR}" == "true" ]]
+      then
+        echo -e "ERROR - At least one required variable is not defined !"
+        return 1
+      fi
+
+# Set variables for the dev branches CI.
+pre_test_dev:
+  <<: *script_pre_test_ensure_variable
+  <<: *only_dev
+  variables:
+    CI_DEPLOY_TYPE: "DEV"
+
+# Set variables for the pre-prod branches CI (master and develop).
+pre_test_pre_prod:
+  <<: *script_pre_test_ensure_variable
+  <<: *only_pre_prod
+  variables:
+    CI_DEPLOY_TYPE: "PRE_PROD"
+
+# Set variables for the prod CI, i.e. CI on tags.
+pre_test_prod:
+  <<: *script_pre_test_ensure_variable
+  <<: *only_prod
+  variables:
+    CI_DEPLOY_TYPE: "PROD"
+
+# Jobs in test stage
+# -----------------------------------------------------------------------------
+test_build_local:
+  <<: *tag_docker
+  <<: *image_docker
+  <<: *cache_python
+  <<: *stage_test
+  before_script:
+    - *before_script_python_dependencies
+  script:
+    # Install python test requirements
+    - 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
+
+test_build_monorepo:
+  <<: *tag_docker
+  <<: *image_docker
+  <<: *cache_python
+  <<: *stage_test
+  before_script:
+    - *before_script_python_dependencies
+  script:
+    # 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
+
+# Jobs in build stage
+# -----------------------------------------------------------------------------
+build_html:
+  <<: *tag_docker
+  <<: *image_docker
+  <<: *cache_python_pull
+  <<: *stage_build
+  before_script:
+    - *before_script_python_dependencies
+  script:
+    # Install python documentations requirements
+    - pip3 install -r requirements.docs.txt
+    # Build the documentation
+    - mkdocs build
+  artifacts:
+    paths:
+      - site/
+
+build_pdf:
+  before_script:
+    - *before_script_python_dependencies
+  <<: *tag_docker
+  <<: *image_docker
+  <<: *cache_python_pull
+  <<: *stage_build
+  script:
+    # Install python documentations requirements
+    - pip3 install -r requirements.docs.txt
+    # Export a variable to build the PDF of the documentation
+    - export ENABLE_PDF_EXPORT=1
+    # Build the documentation
+    - mkdocs build
+    - cp docs/versions.json site/
+  artifacts:
+    paths:
+      - docs/docs.pdf
+
+# Jobs in deploy stage
+# -----------------------------------------------------------------------------
+# Template jobs script deploy previously built html documentation.
+.script_deploy_html: &script_deploy_html
+  <<: *tag_docker
+  <<: *image_docker
+  <<: *stage_deploy
+  needs:
+    - build_html
+  before_script:
+    - *before_script_export_variable
+    - *before_script_prepare_deployment
+  script:
+    - git fetch --all
+    - export LAST_TAG="$(git describe --tags `git rev-list --tags --max-count=1`)"
+    - export LAST_TAG="${LAST_TAG/v/}"
+    - export LAST_TAG="${LAST_TAG%.*}"
+    - export RSYNC_PATH="/${PROJECT_PATH}${LAST_TAG}"
+    - export ONLINE_PATH="${ONLINE_DEST}${PROJECT_PATH}${LAST_TAG}"
+    - mkdir -p "tmp/${RSYNC_PATH}"
+    - cp site/versions.json versions.json
+    - mv site/* "tmp/${RSYNC_PATH}/"
+    - rsync -avz "tmp/" "${RSYNC_DEST}"
+    - echo -e "
+      <!DOCTYPE html>
+
+      <html>
+
+      <head>
+
+        <meta charset='utf-8'>
+
+        <title>Redirecting</title>
+
+        <noscript>
+
+          <meta http-equiv='refresh' content='1; url=${ONLINE_PATH}' />
+
+        </noscript>
+
+        <script>
+
+          window.location.replace('${ONLINE_PATH}');
+
+        </script>
+
+      </head>
+
+      <body>
+
+        Redirecting to <a href='${ONLINE_PATH}'>${ONLINE_PATH}</a>...
+
+      </body>
+
+      </html>" > index.html
+    - rsync -avz index.html "${RSYNC_DEST}${PROJECT_PATH}/"
+    - rsync -avz versions.json "${RSYNC_DEST}${PROJECT_PATH}/"
+
+deploy_html_dev:
+  <<: *script_deploy_html
+  <<: *only_dev
+  variables:
+    CI_DEPLOY_TYPE: "PRE_PROD"
+    PROJECT_PATH: ${CI_COMMIT_REF_NAME%-*}/$CI_PROJECT_PATH/
+
+deploy_html_pre_prod:
+  <<: *script_deploy_html
+  <<: *only_pre_prod
+  variables:
+    CI_DEPLOY_TYPE: "PRE_PROD"
+    PROJECT_PATH: ${CI_COMMIT_REF_NAME%-*}/$CI_PROJECT_PATH/
+
+deploy_html_prod:
+  <<: *script_deploy_html
+  <<: *only_prod
+  variables:
+    CI_DEPLOY_TYPE: "PROD"
+    PROJECT_PATH: ${CI_COMMIT_REF_NAME%-*}/$CI_PROJECT_PATH/
+
+.script_deploy_pdf: &script_deploy_pdf
+  <<: *tag_docker
+  <<: *image_docker
+  <<: *cache_python
+  <<: *stage_deploy
+  needs:
+    - build_pdf
+  before_script:
+    - *before_script_export_variable
+    - *before_script_prepare_deployment
+  script:
+    - mkdir -p "tmp/${CI_PROJECT_PATH}"
+    - mv "docs/docs.pdf" "tmp/${CI_PROJECT_PATH}/${CI_PROJECT_NAME}.pdf"
+    - rsync -avz "tmp/" "${RSYNC_DEST}"
+
+deploy_pdf_dev:
+  <<: *script_deploy_pdf
+  <<: *only_dev
+  variables:
+    CI_DEPLOY_TYPE: "DEV"
+    PROJECT_PATH: ${CI_COMMIT_REF_NAME%-*}/$CI_PROJECT_PATH/
+
+deploy_pdf_pre_prod:
+  <<: *script_deploy_pdf
+  <<: *only_pre_prod
+  variables:
+    CI_DEPLOY_TYPE: "PRE_PROD"
+    PROJECT_PATH: ${CI_COMMIT_REF_NAME%-*}/$CI_PROJECT_PATH/
+
+deploy_pdf_prod:
+  <<: *stage_deploy
+  <<: *script_deploy_pdf
+  <<: *only_prod
+  variables:
+    CI_DEPLOY_TYPE: "PROD"
+    PROJECT_PATH: ${CI_COMMIT_REF_NAME%-*}/$CI_PROJECT_PATH/
+
+# Jobs in post_deploy stage
+# -----------------------------------------------------------------------------
+trigger_main_repo:
+  <<: *stage_post_deploy
+  <<: *only_trigger
+  only:
+    variables:
+      - $MAIN_PROJECT && $MAIN_PROJECT != $CI_PROJECT_PATH
+  trigger:
+    include:
+      - project: $MAIN_PROJECT
+        ref: $CI_COMMIT_REF_NAME
+        file: $MAIN_PROJECT_CI_PATH/.gitlab-ci.yml
+    strategy: depend
+  variables:
+    MAIN_PROJECT_CI_PATH: ${MAIN_PROJECT_CI_PATH:-"."}
+
+inform_triggers_variables:
+  <<: *tag_docker
+  <<: *image_docker
+  <<: *stage_post_deploy
+  <<: *only_trigger
+  except:
+    variables:
+      - $MAIN_PROJECT
+  script:
+    - |
+      if [[ -z "${MAIN_PROJECT}" ]]
+      then
+       echo -e "
+          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
+
+# *****************************************************************************
+# VIM MODELINE
+# vim: fdm=indent
+# *****************************************************************************
+
+### END MKDOCS TEMPLATE ###
+
+

docs/_data/mkdocs_template.yaml

+# Repo information
+# ===========================================================================
+# First key MUST be the "slug" of the repo based on the remote, i.e. if remote
+# is git@git.domain.tld:username/repo_name.git, then the key will be
+# `repo_name`.
+mkdocs_template:
+
+  # An explicit name for the repo that will be shown on the documentation
+  # page.
+  name: "Mkdocs Template"
+
+  #logo: assets/img/meta/mkdocs_template_logo.png
+
+  # (OPTIONATL) An extension of the explicit name with the namespace in which
+  # the repo is. For instance, using above remote, the entry will be
+  # `Username / Repo Name`.
+  # This entry is not used in the configuration of mkdocs.
+  git_name_with_namespace: "My Programs / Mkdocs Template"
+
+  # The complete path of the repo from the git_platform["url"]. For instance,
+  # using, above remote, the entry will be `username/repo_name.git`
+  git_slug_with_namespace: "rdeville.public/my_programs/mkdocs_template"
+
+  # If the repo documentation is part of a bigger repo, then provide the
+  # path of the rendered documentation. If the documentation is not part of
+  # another repo, leave it empty.
+  url_slug_with_namespace: "my_programs/mkdocs_template"
+
+  # (OPTIONAL) Path, relative to `docs_dir` mkdocs config, to the logo of the
+  # repo. If not specified, path will automatically be set to
+  # `assets/img/meta/reop_name_logo.png`
+  #logo: "assets/img/meta/repo_template_logo.png"
+  # Description of the repo, will be used to setup the mkdocs description.
+  desc: >-
+    Mkdocs Templates scaffolding project to host documentation configuration
+    and themes to manage homogenous documentation accros multiple projects.
+
+  # (OPTIONAL) If you plan to use `mkdocstring` plugins to render python
+  # source code, you will need to provide the path where your source files
+  # are relative to the root of the repo.
+  src_path:
+    - "templates/docs/_data/"
+
+  # List of informations about the main maintainers that will be automatically
+  # added to the license file in `docs/about/license.md`
+  maintainers:
+    - name: "Romain Deville"
+      mail: "dev@romaindeville.fr"
\ No newline at end of file

docs/_data/schema/repo.schema.yaml

+# Schema to validate yaml files describing repo information
+type: map
+mapping:
+  regex;([a-zA-z0-9_-]+):
+    type: map
+    required: true
+    example: >-
+      Provide a dictionnary which main key is compose of alphanumerical values
+      with `-` and `_`.
+    mapping:
+      regex;(name|git_slug_with_namespace|desc):
+        type: str
+        required: true
+        example: >-
+          Key `name`, `git_slug_with_namespace` and `desc` are string and are
+          required.
+      regex;(git_name_with_namespace|logo):
+        type: str
+        required: false
+        example: >-
+          Key `git_name_with_namespace` and `logo` are string and are not
+          required.
+      src_path:
+        type: seq
+        required: false
+        example: >-
+          Key `src_path` is a list of string and is not required.
+        sequence:
+          - type: str
+      maintainers:
+        type: seq
+        required: true
+        example: >-
+          Key `src_path` is a list of dictionary and is required.
+        sequence:
+          - type: map
+            mapping:
+              regex;(name|mail):
+                type: str
+                required: true
+                example: >-
+                  Key `name` and `mail` are string and are required.

docs/_data/schema/subrepo.schema.yaml

+# Schema to validate subrepo.yml
+schema;subrepo_map:
+  type: map
+  required: true
+  example: >-
+    Provide a dictionary which main key is compose of alphanumerical values
+    with `-` and `_`.
+  mapping:
+    nav_entry:
+      type: str
+      required: false
+      example: >-
+        Key `nav_entry` is a str corresponding to the entry in the `nav` key.
+    internal:
+      type: seq
+      required: false
+      example: >-
+        Key `internal` is a list of dictionary information.
+      sequence:
+        - type: map
+          required: true
+          example: >-
+            Dict storing information about the subrepo which will be
+            cloned/pulled.
+          mapping:
+            name:
+              type: str
+              required: true
+              example: >-
+                Key `name` is a str, the foler where the subrepo should be
+                cloned/pulled.
+            git_url:
+              type: str
+              required: true
+              example: >-
+                Key `git_url` is a str validate again a regexp which hold the SSH or
+                HTTP URL of the repo to be cloned/pulled.
+            nav_entry:
+              type: str
+              required: true
+              example: >-
+                Key `nav_entry` is a str corresponding to the entry in the `nav`
+                key.
+            subpath:
+              type: str
+              required: false
+              example: >-
+                Key `subpath` is a str pointing to the path in the subrepo where
+                there is a file `mkdocs.yaml` and folder `docs`.
+    external:
+      type: seq
+      required: false
+      example: >-
+        Key `internal` is a list of dictionary information.
+      sequence:
+        - type: map
+          required: true
+          example: >-
+            Dict storing information about the subrepo which will be
+            cloned/pulled.
+          mapping:
+            name:
+              type: str
+              required: true
+              example: >-
+                Key `name` is a str, the foler where the subrepo should be
+                cloned/pulled.
+            git_url:
+              type: str
+              required: true
+              example: >-
+                Key `git_url` is a str validate again a regexp which hold the SSH or
+                HTTP URL of the repo to be cloned/pulled.
+            nav_entry:
+              type: str
+              required: true
+              example: >-
+                Key `nav_entry` is a str corresponding to the entry in the `nav`
+                key.
+            subpath:
+              type: str
+              required: false
+              example: >-
+                Key `subpath` is a str pointing to the path in the subrepo where
+                there is a file `mkdocs.yaml` and folder `docs`.
+            online_url:
+              type: str
+              required: true
+              example: >-
+                Key `online_url` is a str pointing to online URL of the subrepo
+                documentation. Can be a full URL or a path relative to the root
+    regex;([a-zA-z0-9_-]+):
+      include: subrepo_map
+
+type: map
+required: true
+mapping:
+  subrepo:
+    include: subrepo_map

docs/_data/schema/vars.schema.yaml

+# Schema to validate vars.yml
+type: map
+mapping:
+# Mkdocs.yaml Section Schema
+# ---------------------------------------------------------------------------
+  regex;(site_name|site_desc|copyright|repo_name):
+    type: str
+    required: false
+    example: >-
+      Key `site_name`, `site_desc`, `site_url`, `copyright` or `repo_name` are
+      string and are optional
+  regex;(site_url|repo_url|site_base_url):
+    type: url
+    required: false
+    example: >-
+      Key `site_name`, `site_desc`, `site_url`, `copyright` or `repo_name` are
+      valid URL and are optional
+  theme:
+    type: map
+    required: false
+    example: Dictionary key `theme` is optional
+    mapping:
+      regex;(name|custom_dir|language|logo|favicon):
+        type: str
+        required: false
+        example: >-
+          Key `name`, `custom_dir`, `language`, `logo` or `favicon` are string
+          and are optional
+      regex;(include_search_page|search_index_only):
+        type: bool
+        required: false
+        example: >-
+          Key `include_search_page` and `search_index_only` are boolean and
+          are optional
+      features:
+        type: seq
+        required: false
+        example: List key `features` is composed of string and is optional
+        sequence:
+          - type: str
+      palette:
+        type: map
+        required: false
+        example: Dictionary key `palette` is optional
+        mapping:
+          regex;(scheme|primary|accent):
+            type: str
+            required: false
+            example: >-
+              Key `scheme`, `primary` or `accent` are string and are optional
+      font:
+        type: map
+        required: false
+        example: Dictionary key `palette` is optional
+        mapping:
+          regex;(text|code):
+            type: str
+            required: false
+            example: >-
+              Key `text` or `code` are string and are optional
+      icon:
+        type: map
+        required: false
+        example: Dictionary key `icon` is optional
+        mapping:
+          regex;(logo|repo):
+            type: str
+            required: false
+            example: >-
+              Key `logo` or `repo` are string and are optional
+# Git platform section schema
+# ---------------------------------------------------------------------------
+  git_platform:
+    type: map
+    required: true
+    example: Dictionary key `git_platform` is required
+    mapping:
+      regex;(logo|icon|name):
+        type: str
+        required: true
+        example: >-
+          Key `logo`, `icon` and `name are string and are required`
+      url:
+        type: url
+        required: true
+        example: >-
+          Key `url` is a URL and is required
\ No newline at end of file

docs/_data/template/repo.tpl.yaml

+# Repo information
+# ===========================================================================
+# First key MUST be the "slug" of the repo based on the remote, i.e. if remote
+# is git@git.domain.tld:username/repo_name.git, then the key will be
+# `repo_name`.
+repo_name:
+
+  # An explicit name for the repo that will be shown on the documentation
+  # page.
+  name: "My Repo Name"
+
+  # (OPTIONATL) An extension of the explicit name with the namespace in which
+  # the repo is. For instance, using above remote, the entry will be
+  # `Username / Repo Name`.
+  # This entry is not used in the configuration of mkdocs.
+  git_name_with_namespace: "Namespace / My Repo Name"
+
+  # The complete path of the repo from the git_platform["url"]. For instance,
+  # using, above remote, the entry will be `username/repo_name.git`
+  git_slug_with_namespace: "namespace/repo_name"
+
+  # If the repo documentation is part of a bigger repo, then provide the
+  # path of the rendered documentation. If the documentation is not part of
+  # another repo, leave it empty.
+  url_slug_with_namespace: "subpath_for_url_renderin/repo_slug"
+
+  # (OPTIONAL) Path, relative to `docs_dir` mkdocs config, to the logo of the
+  # repo. If not specified, path will automatically be set to
+  # `assets/img/meta/reop_name_logo.png`
+  #logo: "assets/img/meta/repo_template_logo.png"
+  # Description of the repo, will be used to setup the mkdocs description.
+  desc: >-
+    Repo description with markdown support
+
+  # (OPTIONAL) If you plan to use `mkdocstring` plugins to render python
+  # source code, you will need to provide the path where your source files
+  # are relative to the root of the repo.
+  src_path:
+    - "src"
+
+  # List of informations about the main maintainers that will be automatically
+  # added to the license file in `docs/about/license.md`
+  maintainers:
+    - name: "Firstname Lastname"
+      mail: "mail@domain.tld"
\ No newline at end of file

docs/_data/template/subrepo.tpl.yaml

+# Subrepo Information
+# ---------------------------------------------------------------------------
+# Dictionnary storing location of subrepo to be included in the main repo
+# documentation
+
+# The main key MUST be `subrepo`.
+subrepo:
+  # You can provide multiple nesting level of dictionary defining path to
+  # the subrepo to include to the main repo documentation such as:
+  # # Name of the directory
+  # ```
+  # dir_name:
+  #   # Corresponding EXISTING entry in the `nav` key of mkdocs.
+  #   nav_entry: "Nav Entry"
+  #   # List of subdirectory from `dir_name` which are repos with
+  #   # mkdocs documentation for which only link to the repo documentation
+  #   # will be provided.
+  #   external:
+  #       # i.e. There is a file `mkdocs.yaml` in
+  #       # `dir_name/subrepo_1/mkdocs.yaml` and
+  #       # `dir_name/subrepo_1/docs/_data/subrepo_1.yaml`
+  #     - name: subrepo_1
+  #       # SSH or HTTP link to the online subrepo_1
+  #       git_url: git@domain.tld:namesapce/subrepo_1
+  #   # List of subdirectory from `dir_name` which are repos with
+  #   # mkdocs documentation which will be included in the documentation.
+  #   external:
+  #       # i.e. There is a file `mkdocs.yaml` in
+  #       # `dir_name/subrepo_2/mkdocs.yaml` and
+  #       # `dir_name/subrepo_2/docs/_data/subrepo_2.yaml`
+  #     - name: subrepo_2
+  #       # SSH or HTTP link to the online subrepo_2
+  #       git_url: git@domain.tld:namesapce/subrepo_2
+  #   # Another sub dir_name which also old subrepos
+  #   subdir_name:
+  #     nav_entry: "Sub Nav Entry"
+  #       [...]
+  # # Another sub dir_name which also old subrepos
+  # another_dir_name:
+  #   nav_entry: "Another Nav Entry"
+  #     [...]
+  # ```
+
+  # Below is a short example used for the rendering of
+  # `docs.romaindeville.fr`
+  my_dotfiles:
+    nav_entry: My Dotfiles
+    internal:
+      - name: myrepos
+        nav_entry: MyRepos Template
+        git_url: git@framagit.org:rdeville.private/my_dotfiles/myrepos.git
+  my_program:
+    nav_entry: My Programs
+    external:
+      - name: direnv_template
+        nav_entry: Direnv Template
+        git_url: git@framagit.org:rdeville.private/my_programs/direnv_template.git
+      - name: mkdocs_template
+        nav_entry: Mkdocs Template
+        git_url: git@framagit.org:rdeville.private/my_programs/mkdocs_template.git
+
+  # This example will allow to add the following content to the `nav` key
+  # ```
+  # nav:
+  #   [...]
+  #   - My Dotfiles:
+  #     # Monorepo will include following mkdocs.yaml
+  #     - MyRepos Template: !include my_dotfiles/myrepos/mkdocs.yaml
+  #   - My Programs:
+  #     # A link will be provided to the external documentation
+  #     - Direnv Template: /my_program/direnv_template/
+  #     - Mkdocs Template: /my_program/mkdocs_template/
+  # ```

docs/_data/template/vars.tpl.yaml

+# Extra Data Information & Customization
+# ===========================================================================
+# Dictionnary storing variables to be used as "Jinja2" variables within
+# markdown files and _data/plugins.py
+
+# Mkdocs.yaml
+# ---------------------------------------------------------------------------
+# Here you can overwrite main key you could find in mkdocs.yaml
+
+# The name of your site, if not specified, will be the entry `name` of the repo in
+# `_data/repo_name.yaml`
+#site_name: "Your Site Name"
+
+# The site description of your site, if not specified will be the description
+# of the repo in `_data/repo_name.yaml`
+#site_desc: "A short description"
+
+# The url of your site, if not specified, then the site_url will be build from
+# the key `site_base_url` below and the `url_slug_with_namespace` in
+# `_data/repo_name.yaml`. If `site_base_url` is not specified, then value of
+# `site_url` will not be overwritten.
+#site_url: "https://my_site.tld"
+
+# The name or company which old the copyright. No need to specify any date
+# as it will be built based on the first commit of your repo. If not specify,
+# then no copyright will be shown on the footer of the documentation.
+#copyright: "Firstname Lastname"
+
+# Name of your repo, if not specified, will be the key `mkdocs_repo_name` in
+# `_data/repo_name.yaml` If value is EXACTLY "!!git_platform", then the value
+# will be `git_platform["name"]` (see below).
+#repo_name: "My Repo Name"
+
+# URL to the source code of your repo. If not specified, will be build from
+# `git_platform["url"]` (see below) and `repo_name["git_slug_with_namespace"]`
+# in `_data/repo_name.yaml`.
+#repo_url: "https://mygit.tld/namespace/repo_name
+
+# You can override every entry of the `theme` key in `mkdocs.yaml`, here.
+# Usefull to override templated mkdocs.
+#
+# REMARK, ONLY FOR MATERIAL-MKDOCS THEME
+#   If `theme["logo"]` is not specified, i.e. path to the logo image, then it
+#   will be set to the value of the key `repo_name["logo"]` in
+#   `_data/repo_name.yaml` if specified.
+#
+#   If `theme["favicon"]` is not specified, i.e. path to the favicon image,
+#   then it will be set to the value of the key `repo_name["logo"]` in
+#   `_data/repo_name.yaml` if specified.
+#
+#   If `theme["icon"]["repo"]` is not specified, i.e. icon "path" (see
+#   https://squidfunk.github.io/mkdocs-material/reference/icons-emojis/) that
+#   will be shown on the top rigt corner in front off the repo name, then it
+#   will be set to the value of the key `git_platform["icon"]` (see below).
+#theme:
+#  logo: "path/to/logo.svg"
+#  icon:
+#    repo:  fontawesome/brands/gitlab
+#  favicon: "path/to/favicon.svg"
+
+# Main repo configuration
+# ---------------------------------------------------------------------------
+# Here you can specify variable about your main repo documentation
+
+# 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"
+
+
+# Git platform
+# ---------------------------------------------------------------------------
+# In this REQUIRED section you will be able to specify some information for you
+# git platform hosting your repo. This section will be used to automatically
+# setup configuration for mkdocs such as `repo_url`, theme["icon"]["repo"] etc.
+
+# Main dict entry
+git_platform:
+  # The logo of the git platform you use. Not used in mkdocs configuration but
+  # can be used in markdown documentation file.
+  logo: " "
+  # Icon "path" (see
+  # https://squidfunk.github.io/mkdocs-material/reference/icons-emojis/) that
+  # will be shown on the top rigt corner in front off the repo name if not
+  # specified in `theme["icon"]["repo"]`.
+  icon: "fontawesome/brands/gitlab"
+  # Name of the platform you use.
+  name: "Framagit"
+  # URL of the platform you use, to be able to set `repo_url` for mkdocs
+  # configuration.
+  url: "https://framagit.org/"

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
+# markdown files and _data/plugins.py
+
+# Mkdocs.yaml
+# ---------------------------------------------------------------------------
+# Here you can overwrite main key you could find in mkdocs.yaml
+
+# The name of your site, if not specified, will be the entry `name` of the repo in
+# `_data/repo_name.yaml`
+#site_name: "Your Site Name"
+
+# The site description of your site, if not specified will be the description
+# of the repo in `_data/repo_name.yaml`
+#site_desc: "A short description"
+
+# The url of your site, if not specified, then the site_url will be build from
+# the key `site_base_url` below and the `url_slug_with_namespace` in
+# `_data/repo_name.yaml`. If `site_base_url` is not specified, then value of
+# `site_url` will not be overwritten.
+#site_url: "https://my_site.tld"
+
+# The name or company which old the copyright. No need to specify any date
+# as it will be built based on the first commit of your repo. If not specify,
+# then no copyright will be shown on the footer of the documentation.
+#copyright: "Firstname Lastname"
+
+# Name of your repo, if not specified, will be the key `mkdocs_repo_name` in
+# `_data/repo_name.yaml` If value is EXACTLY "!!git_platform", then the value
+# will be `git_platform["name"]` (see below).
+#repo_name: "My Repo Name"
+
+# URL to the source code of your repo. If not specified, will be build from
+# `git_platform["url"]` (see below) and `repo_name["git_slug_with_namespace"]`
+# in `_data/repo_name.yaml`.
+#repo_url: "https://mygit.tld/namespace/repo_name
+
+# You can override every entry of the `theme` key in `mkdocs.yaml`, here.
+# Usefull to override templated mkdocs.
+#
+# REMARK, ONLY FOR MATERIAL-MKDOCS THEME
+#   If `theme["logo"]` is not specified, i.e. path to the logo image, then it
+#   will be set to the value of the key `repo_name["logo"]` in
+#   `_data/repo_name.yaml` if specified.
+#
+#   If `theme["favicon"]` is not specified, i.e. path to the favicon image,
+#   then it will be set to the value of the key `repo_name["logo"]` in
+#   `_data/repo_name.yaml` if specified.
+#
+#   If `theme["icon"]["repo"]` is not specified, i.e. icon "path" (see
+#   https://squidfunk.github.io/mkdocs-material/reference/icons-emojis/) that
+#   will be shown on the top rigt corner in front off the repo name, then it
+#   will be set to the value of the key `git_platform["icon"]` (see below).
+#theme:
+#  logo: "path/to/logo.svg"
+#  icon:
+#    repo:  fontawesome/brands/gitlab
+#  favicon: "path/to/favicon.svg"
+
+# Main repo configuration
+# ---------------------------------------------------------------------------
+# Here you can specify variable about your main repo documentation
+
+# 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"
+
+
+# Git platform
+# ---------------------------------------------------------------------------
+# In this REQUIRED section you will be able to specify some information for you
+# git platform hosting your repo. This section will be used to automatically
+# setup configuration for mkdocs such as `repo_url`, theme["icon"]["repo"] etc.
+
+# Main dict entry
+git_platform:
+  # The logo of the git platform you use. Not used in mkdocs configuration but
+  # can be used in markdown documentation file.
+  logo: " "
+  # Icon "path" (see
+  # https://squidfunk.github.io/mkdocs-material/reference/icons-emojis/) that
+  # will be shown on the top rigt corner in front off the repo name if not
+  # specified in `theme["icon"]["repo"]`.
+  icon: "fontawesome/brands/gitlab"
+  # Name of the platform you use.
+  name: "Framagit"
+  # 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/data_privacy.md

+# Data Privacy
+
+In itself, [Material for MkDocs][mkdocs_material] theme use for this
+documentation does not perform any tracking and should adhere to the General
+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.
+
+[mkdocs_material]: https://squidfunk.github.io/mkdocs-material/data-privacy/

docs/about/index.md

+<!-- BEGIN MKDOCS TEMPLATE -->
+# About
+
+In this part of the documentation, you can consult:
+
+  - [Data Privacy](data_privacy.md)
+<!-- END MKDOCS TEMPLATE -->

docs/index.md

+<!-- BEGIN MKDOCS TEMPLATE -->
+<!-- END MKDOCS TEMPLATE -->
\ No newline at end of file

mkdocs.yml

@@ -44,79 +44,37 @@ theme:
     - navigation.tabs
     - navigation.instant
     - navigation.top
-  # Setting colors palette (these are defined in docs/theme/css/{colors,theme}.css)
+  # Setting colors palette
   palette:
-    # Light mode
+      # Light mode
     - media: "(prefers-color-scheme: light)"
-      scheme: rdeville-light
-      primary: rdeville-green-light
-      accent: rdeville-orange-light
+      scheme: default
+      primary: deep-purple
+      accent: yellow
       toggle:
-        icon: material/weather-night
+        icon: material/weather-sunny
         name: Switch to dark mode
     # Dark mode
     - media: "(prefers-color-scheme: dark)"
-      scheme: rdeville-dark
-      primary: rdeville-green-dark
-      accent: rdeville-orange-dark
+      scheme: slate
+      primary: deep-purple
+      accent: yellow
       toggle:
-        icon: material/weather-sunny
+        icon: material/weather-night
         name: Switch to light mode
-  # Font configuration for the website (FurCode are provided in
-  # docs/theme/fonts)
+  # Font configuration for the website
   font: false
-  #  text: FuraCode Nerd Font
-  #  code: FuraCode Nerd Font
+  #  text:
+  #  code:
   # Path to logo and icons to use for the website
   #logo:    # Automatically set by mkdocs_macros_plugin (see docs/_data/plugins.py)
   #icon:
   #  repo:  # Automatically set by mkdocs_macros_plugin (see docs/_data/plugins.py)
   #favicon: # Automatically set by mkdocs_macros_plugin (see docs/_data/plugins.py)
 
-# External CSS
-# ---------------------------------------------------------------------------
-extra_css:
-  # Define css for lightgallery
-  # From: https://github.com/g-provost/lightgallery-markdown
-  - theme/css/lightgallery.css
-  # Define personal extra css
-  # Define colors (all materials colors RGB code)
-  - theme/css/colors.css
-  # Define fonts
-  - theme/css/fonts.css
-  # Define themes
-  - theme/css/theme.css
-  # Define css of base markdown extension and pymdown extension
-  - theme/css/python_markdown_extension.css
-
-# External JS
-# ---------------------------------------------------------------------------
-extra_javascript:
-  # Define javascript for lightgallery
-  # From: https://github.com/g-provost/lightgallery-markdown
-  - theme/js/lightgallery.js
-  - theme/js/lg-video.js
-  # Define javascript for arithmatex (auto downloaded with tools/upgrade_external_dependencies)
-  # From: https://squidfunk.github.io/mkdocs-material/reference/mathjax/#arithmatex
-  - theme/js/polyfill.js
-  - theme/js/es5/tex-chtml.js
-  # Define javascript to allow table sorting
-  # From: https://squidfunk.github.io/mkdocs-material/reference/data-tables/#sortable-tables
-  - theme/js/tablesort.min.js
-  # Define javascript for mermaid
-  # From: https://github.com/fralau/mkdocs-mermaid2-plugin#explicit-declaration-of-the-mermaid-library
-  - theme/js/mermaid.js
-  # Define javascript for custom pymdown mermaid loader
-  # From: https://facelessuser.github.io/pymdown-extensions/extras/mermaid/#custom-loader
-  - theme/js/mermaid-loader.js
-  # Define personal custom javascript
-  - theme/js/extra.js
-
 # Extensions
 # ---------------------------------------------------------------------------
 markdown_extensions:
-  # Allow to include markdown files
-  # https://github.com/sethen/markdown-include
   - markdown_include.include:
       base_path: ./
   # Python Markdown Extensions
@@ -136,89 +94,53 @@ markdown_extensions:
   - markdown.extensions.md_in_html:
   # Pymdown Extensions
   # https://facelessuser.github.io/pymdown-extensions/extensions/arithmatex/
-  - pymdownx.extra:
-  - pymdownx.arithmatex:
-      generic: true
   - pymdownx.betterem:
-  - pymdownx.details:
-  - pymdownx.caret:
-  - pymdownx.escapeall:
-      hardbreak: True
-      nbsp: True
-  - pymdownx.critic:
-  - pymdownx.emoji:
-      emoji_index: !!python/name:pymdownx.emoji.twemoji
-      emoji_generator: !!python/name:pymdownx.emoji.to_svg
-      options:
-        image_path: /assets/twemoji/svg/
-        custom_icons:
-          - .icons
-  - pymdownx.inlinehilite:
-      custom_inline:
+  - pymdownx.tabbed:
+  - pymdownx.superfences:
+      preserve_tabs: true
+      # Make exceptions to highlighting code of following classes:
+      custom_fences:
         - name: math
           class: arithmatex
-          format: !!python/name:pymdownx.arithmatex.inline_generic_format
+          format: !!python/name:pymdownx.arithmatex.fence_mathjax_format
   - pymdownx.highlight:
-      linenums: true
-      linenums_special: 2
-      linenums_style: pymdownx-inline
-      guess_lang: false
       extend_pygments_lang:
+        - name: php-inline
+          lang: php
+          options:
+            startinline: true
         - name: pycon3
           lang: pycon
           options:
             python3: true
-  - pymdownx.keys:
-      separator: "\uff0b"
-  - pymdownx.mark:
-  - pymdownx.magiclink:
-      repo_url_shortener: true
-  - pymdownx.progressbar:
-  - pymdownx.pathconverter:
-  - pymdownx.smartsymbols:
-  - pymdownx.snippets:
-  - pymdownx.striphtml:
-  - pymdownx.superfences:
-      preserve_tabs: true
-      # Make exceptions to highlighting code of following classes:
-      custom_fences:
+      linenums_style: pymdownx-inline
+  - pymdownx.inlinehilite:
+      custom_inline:
         - name: math
           class: arithmatex
-          format: !!python/name:pymdownx.arithmatex.fence_generic_format
-        - name: mermaid
-          class: mermaid
-          format: !!python/name:pymdownx.superfences.fence_code_format
-  - pymdownx.tabbed:
+          format: !!python/name:pymdownx.arithmatex.inline_mathjax_format
+  - pymdownx.tilde:
+  - pymdownx.caret:
+  - pymdownx.critic:
+  - pymdownx.smartsymbols:
+  - pymdownx.emoji:
+      emoji_index: !!python/name:materialx.emoji.twemoji
+      emoji_generator: !!python/name:materialx.emoji.to_svg
+      options:
+        custom_icons:
+          - .icons
+  - pymdownx.escapeall:
+      hardbreak: True
+      nbsp: True
   - pymdownx.tasklist:
       custom_checkbox: true
-  - pymdownx.tilde:
-  # Locally installed in docs/theme/plugins/ from original repo
-  # https://github.com/g-provost/lightgallery-markdown
-  - lightgallery:
-
-# Extra Data Information & Customization
-# ---------------------------------------------------------------------------
-# Dictionary storing social icon that will be shown on the bottom right.
-extra:
-  social:
-    - icon: fontawesome/solid/globe
-      link: https://romaindeville.fr
-    - icon: fontawesome/solid/paper-plane
-      link: mailto:contact@romaindeville.fr
-    - icon: fontawesome/solid/book-reader
-      link: https://docs.romaindeville.fr
-    - icon: fontawesome/brands/linkedin
-      link: https://www.linkedin.com/in/romaindeville
-    - icon: fontawesome/brands/docker
-      link: https://hub.docker.com/u/rdeville
-    - icon: fontawesome/brands/git-alt
-      link: https://framagit.org/rdeville.public/
-    - icon: fontawesome/brands/gitlab
-      link: https://gitlab.com/rdeville.public/
-    - icon: fontawesome/brands/github
-      link: https://github.com/rdeville-public/
-  version:
-    provider: mike
+  - pymdownx.progressbar:
+  - pymdownx.arithmatex:
+  - pymdownx.mark:
+  - pymdownx.striphtml:
+  - pymdownx.keys:
+      separator: "\uff0b"
+  - pymdownx.details:
 
 # Plugins
 # ---------------------------------------------------------------------------
@@ -251,12 +173,6 @@ plugins:
     # This plugin enables you to build multiple sets of documentation in a
     # single Mkdocs.
   - monorepo:
-  # A Mermaid graphs plugin for mkdocs
-  # https://github.com/fralau/mkdocs-mermaid2-plugin#declaring-the-superfences-extension
-  - mermaid2:
-      arguments:
-        theme: |
-          ^(localStorage.getItem('theme') === 'rdeville-dark') ? 'dark'  : 'light'
     # https://pawamoy.github.io/mkdocstrings/
     # Automatic documentation from sources, for MkDocs.
   - mkdocstrings:
@@ -271,7 +187,7 @@ plugins:
             # Others command such as sys.path.append("path") are
             # Automatically added using mkdocs_macros_plugin
             # (see docs/_data/plugins.py)
-# DO NOT FORGET TO ADD/UPDATE THE \`nav\` KEY BELOW.
+# DO NOT FORGET TO ADD/UPDATE THE \`nav\` AND \`extra\` KEYS BELOW.
 ### END MKDOCS TEMPLATE ###
 
 # Navigation Pane

requirements.docs.in

+
 ### BEGIN MKDOCS TEMPLATE ###
 ### WARNING, DO NOT UPDATE CONTENT BETWEEN MKDOCS TEMPLATE TAG !###
 ### Modified content will be overwritten when updating.###
@@ -15,7 +16,7 @@ mkdocs
 
 # A Material Design theme for MkDocs
 # https://pypi.org/project/mkdocs-material/
-mkdocs-material>=7.0
+mkdocs-material
 
 # Plugin for adding monorepository support in Mkdocs.
 # https://pypi.org/project/mkdocs-monorepo-plugin/
@@ -46,16 +47,9 @@ mkdocs-macros-plugin
 # https://github.com/apenwarr/mkdocs-exclude
 mkdocs-exclude
 
-# Markdown extension to wrap images in a lightbox.
-# https://github.com/g-provost/lightgallery-markdown
-git+https://github.com/g-provost/lightgallery-markdown
-
-# A Mermaid graphs plugin for mkdocs
-# https://github.com/fralau/mkdocs-mermaid2-plugin#declaring-the-superfences-extension
-mkdocs-mermaid2-plugin
-
 # Python lib/cli for JSON/YAML schema validation
 # https://pypi.org/project/pykwalify/
 pykwalify
 
 ### END MKDOCS TEMPLATE ###
+

requirements.docs.txt

+
 ### BEGIN MKDOCS TEMPLATE ###
 ### WARNING, DO NOT UPDATE CONTENT BETWEEN MKDOCS TEMPLATE TAG !###
 ### Modified content will be overwritten when updating.###
@@ -12,28 +13,18 @@ astunparse==1.6.3
     # via pytkdocs
 babel==2.9.0
     # via mkdocs-git-revision-date-localized-plugin
-beautifulsoup4==4.9.3
-    # via mkdocs-mermaid2-plugin
-certifi==2020.12.5
-    # via requests
-chardet==4.0.0
-    # via requests
 click==7.1.2
     # via
     #   mkdocs
     #   nltk
 docopt==0.6.2
     # via pykwalify
-editorconfig==0.12.3
-    # via jsbeautifier
 future==0.18.2
     # via lunr
 gitdb==4.0.7
     # via gitpython
 gitpython==3.1.14
     # via mkdocs-git-revision-date-localized-plugin
-idna==2.10
-    # via requests
 jinja2==2.11.3
     # via
     #   mkdocs
@@ -41,10 +32,6 @@ jinja2==2.11.3
     #   mkdocstrings
 joblib==1.0.1
     # via nltk
-jsbeautifier==1.13.5
-    # via mkdocs-mermaid2-plugin
-git+https://github.com/g-provost/lightgallery-markdown
-    # via -r requirements.docs.in
 livereload==2.6.3
     # via mkdocs
 lunr[languages]==0.5.8
@@ -53,7 +40,6 @@ markdown-include==0.6.0
     # via -r requirements.docs.in
 markdown==3.3.4
     # via
-    #   lightgallery
     #   markdown-include
     #   mkdocs
     #   mkdocs-autorefs
@@ -68,21 +54,18 @@ mkdocs-autorefs==0.1.1
     # via mkdocstrings
 mkdocs-exclude==1.0.2
     # via -r requirements.docs.in
-mkdocs-git-revision-date-localized-plugin==0.8
+mkdocs-git-revision-date-localized-plugin==0.9
     # via -r requirements.docs.in
 mkdocs-macros-plugin==0.5.5
     # via -r requirements.docs.in
 mkdocs-material-extensions==1.0.1
     # via mkdocs-material
-mkdocs-material==7.1.0
+mkdocs-material==7.1.1
     # via
     #   -r requirements.docs.in
     #   mkdocs-macros-plugin
     #   mkdocs-material-extensions
-    #   mkdocs-mermaid2-plugin
-mkdocs-mermaid2-plugin==0.5.1
-    # via -r requirements.docs.in
-mkdocs-monorepo-plugin==0.4.13
+mkdocs-monorepo-plugin==0.4.14
     # via -r requirements.docs.in
 mkdocs-section-index==0.2.3
     # via -r requirements.docs.in
@@ -94,7 +77,6 @@ mkdocs==1.1.2
     #   mkdocs-git-revision-date-localized-plugin
     #   mkdocs-macros-plugin
     #   mkdocs-material
-    #   mkdocs-mermaid2-plugin
     #   mkdocs-monorepo-plugin
     #   mkdocs-section-index
     #   mkdocstrings
@@ -109,7 +91,6 @@ pykwalify==1.8.0
 pymdown-extensions==8.1.1
     # via
     #   mkdocs-material
-    #   mkdocs-mermaid2-plugin
     #   mkdocstrings
 python-dateutil==2.8.1
     # via
@@ -123,11 +104,8 @@ pyyaml==5.4.1
     # via
     #   mkdocs
     #   mkdocs-macros-plugin
-    #   mkdocs-mermaid2-plugin
 regex==2021.4.4
     # via nltk
-requests==2.25.1
-    # via mkdocs-mermaid2-plugin
 ruamel.yaml.clib==0.2.2
     # via ruamel.yaml
 ruamel.yaml==0.17.4
@@ -135,14 +113,11 @@ ruamel.yaml==0.17.4
 six==1.15.0
     # via
     #   astunparse
-    #   jsbeautifier
     #   livereload
     #   lunr
     #   python-dateutil
 smmap==4.0.0
     # via gitdb
-soupsieve==2.2.1
-    # via beautifulsoup4
 termcolor==1.1.0
     # via mkdocs-macros-plugin
 tornado==6.1
@@ -151,12 +126,8 @@ tornado==6.1
     #   mkdocs
 tqdm==4.60.0
     # via nltk
-urllib3==1.26.4
-    # via requests
 wheel==0.36.2
     # via astunparse
 
-# The following packages are considered to be unsafe in a requirements file:
-# setuptools
-
 ### END MKDOCS TEMPLATE ###
+