Make workflow only run on framagit.org and move path where index.html is
rsync.

Replace `only` by `rules` in CI.

Update some typos and command order.

🐛⬆ Fix flake8 dependencies and 💚 Upgrade CI

Automatically remove flakehell dependencies from `mkdocs_template_rdeville` as
flakehell seems to be dying.
Replace flakehell by flake9, fork of flake8 with pyproject support.
Update files accordingly.

Fix pydocstyle warning in plugins.py files.

Upgrade CI from mkdocs_template_rdeville.

See merge request rdeville.private/my_programs/mkdocs_template!3

Automatically remove flakehell dependencies from `mkdocs_template_rdeville` as
flakehell seems to be dying.
Replace flakehell by flake9, fork of flake8 with pyproject support.
Update files accordingly.

Fix pydocstyle warning in plugins.py files.

Upgrade CI from mkdocs_template_rdeville.

Update python requirements files to add required dependencies to use the
mkdocs_template_rdeville and upgrade pinned dependencies.

Add/upgrade following files using the mkdocs_template_rdeville:

- .editorconfig
- .yamllint
- mkdocs.yml
- pyproject.toml

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

Due to error when using `tox` about unused args, remove those args from
`set_nav` method in `plugins.py` file.

Add support of extra `nav` key which can be defined in
`docs/_data/extra.yml` allowing to overload the `nav` key of
`mkdocs.yml` file, allowing to forked repo to have their own `nav`
without modifying the `nav` key of the `mkdocs.yml` file.

Fix minor typo in file `docs/_data/plugins.py` not loading `extra.yml`
file correctly.

Release v0.0.1 which:

- 👷‍ Simplify and upgrade CI, now simplier, using rules instead of only.
- 🚨 Update scripts `plugin.py` to be tox compliant
- 🍱 Add mkdocs logo

Due to error when running tox, adding better docstring in `plugin.py`
and update content of `plugin.py` to fix pylint error.

Update and

💚 Fixing & Simplify CI & 🍱 Adding assets

Huge rework of the `docs/.gitlab-ci.yml` to :

- Simplify the file describing the CI process.
- Use `rules` instead of `only/except` to be more flexible in case of future update.
- Update script `docs/_data/plugins.py` to better support external subrepo.
- Adding logo in PNG and SVG format.

See merge request rdeville.private/my_programs/mkdocs_template!2

Huge rework of the `docs/.gitlab-ci.yml` to :

- Simplify the file describing the CI process.
- Use `rules` instead of `only/except` to be more flexible in case of future update.
- Update script `docs/_data/plugins.py` to better support external subrepo.
- Adding logo in PNG and SVG format.

See merge request rdeville.private/my_programs/mkdocs_template!2

💚 Fixing CI

Mainly updating `docs/.gitlab-ci.yml` and `docs/_data/plugins.py` to make the CI working.

Comment formatting test for now.

See merge request rdeville.private/my_programs/mkdocs_template!1

Mainly updating `docs/.gitlab-ci.yml` and `docs/_data/plugins.py` to make the CI working.

Comment formatting test for now.

Use basic mkdocs_template to setup base mkdocs documentation

🔖 v0.0.0

First initial release to test installation with script, base
configuration and CI.

First release of mkdocs_template to allow testing of scripts, base
mkdocs template installation and CI.

Add tool script to generate documentation from shell script based on
docstring.

Add script `setup.sh` which allow to install mkdocs template.

Add more templates files forgotten in the previous commit.

Add base templates folder with :

  - Requirements to build the documentation
  - Basic mkdocs.yml file
  - Template and schema for variables

Disable pylint error for duplicate files and remove preview folder from
pylint test.

Add script `preview.sh` which build the documentation from template and
user config in the folder `preview`.

Add preview folder which hold basic information to render preview of the
template with preview of all python markdown extensions.

Add repo level of gitlab CI which basically :

  - Set CI base
  - Include docs CI
  - Test python and shell formatting

Add following syntax and test config files :
  - pyproject.toml
  - .editorconfig
  - .yamllint