diff --git a/templates/docs/about/data_privacy.md b/templates/docs/about/data_privacy.md new file mode 100644 index 0000000000000000000000000000000000000000..203e7693a132840977530b21da805dd5e4944bcf --- /dev/null +++ b/templates/docs/about/data_privacy.md @@ -0,0 +1,10 @@ +# 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/ diff --git a/templates/docs/about/index.md b/templates/docs/about/index.md new file mode 100644 index 0000000000000000000000000000000000000000..37e10d62dfe4a5f983d278c3db4fad6af37b3fb3 --- /dev/null +++ b/templates/docs/about/index.md @@ -0,0 +1,7 @@ +<!-- BEGIN MKDOCS TEMPLATE --> +# About + +In this part of the documentation, you can consult: + + - [Data Privacy](data_privacy.md) +<!-- END MKDOCS TEMPLATE --> diff --git a/templates/docs/assets/img/meta/.gitkeep b/templates/docs/assets/img/meta/.gitkeep new file mode 100644 index 0000000000000000000000000000000000000000..e69de29bb2d1d6434b8b29ae775ad8c2e48c5391 diff --git a/templates/docs/index.md b/templates/docs/index.md new file mode 100644 index 0000000000000000000000000000000000000000..1a27f310640cdea42f2d00d96dd34b683e916da9 --- /dev/null +++ b/templates/docs/index.md @@ -0,0 +1,2 @@ +<!-- BEGIN MKDOCS TEMPLATE --> +<!-- END MKDOCS TEMPLATE --> \ No newline at end of file diff --git a/templates/docs/theme/.gitkeep b/templates/docs/theme/.gitkeep new file mode 100644 index 0000000000000000000000000000000000000000..e69de29bb2d1d6434b8b29ae775ad8c2e48c5391 diff --git a/templates/mkdocs.local.yml b/templates/mkdocs.local.yml new file mode 100644 index 0000000000000000000000000000000000000000..2f6771e00caf15474bf70cc43e85073e182d767d --- /dev/null +++ b/templates/mkdocs.local.yml @@ -0,0 +1,211 @@ +### BEGIN MKDOCS TEMPLATE ### +# --------------------------------------------------------------------------- +# Below content is automatically managed with repo mkdocs_template. +# Do not edit manually +# --------------------------------------------------------------------------- + +# Website Information +# --------------------------------------------------------------------------- +site_name: "" # Automatically set by mkdocs_macros_plugin (see docs/_data/plugins.py) +#site_description: # Automatically set by mkdocs_macros_plugin (see docs/_data/plugins.py) +#site_url: # Automatically set by mkdocs_macros_plugin (see docs/_data/plugins.py) +#copyright: # Automatically set by mkdocs_macros_plugin (see docs/_data/plugins.py) +docs_dir: docs + +# Repository Information +# --------------------------------------------------------------------------- +#repo_name: # Automatically set by mkdocs_macros_plugin (see docs/_data/plugins.py) +#repo_url: # Automatically set by mkdocs_macros_plugin (see docs/_data/plugins.py) +edit_uri: "" +# This setting controls the style used for linking to pages within the +# documentation. +use_directory_urls: false + +# Theme Configuration +# --------------------------------------------------------------------------- +theme: + # Using mkdocs-material theme + # https://squidfunk.github.io/mkdocs-material/ + name: material + # Overriding parent theme configuration + custom_dir: docs/theme + # Determines whether the search plugin expects the theme to provide a + # dedicated search page via a template located at search/search.html. + include_search_page: false + # Determines whether the search plugin should only generate a search + # index or a complete search solution. + search_index_only: true + # Language site + language: en + # Optional features like tabs and instant loading are now implemented + # as flags and can be enabled by listing them in mkdocs.yml under + # theme.features: + features: + - navigation.tabs + - navigation.instant + - navigation.top + # Setting colors palette + palette: + # Light mode + - media: "(prefers-color-scheme: light)" + scheme: default + primary: deep-purple + accent: yellow + toggle: + icon: material/weather-sunny + name: Switch to dark mode + # Dark mode + - media: "(prefers-color-scheme: dark)" + scheme: slate + primary: deep-purple + accent: yellow + toggle: + icon: material/weather-night + name: Switch to light mode + # Font configuration for the website + font: false + # 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) + +# Extensions +# --------------------------------------------------------------------------- +markdown_extensions: + - markdown_include.include: + base_path: ./ + # Python Markdown Extensions + # https://python-markdown.github.io/extensions/ + - markdown.extensions.toc: + slugify: !!python/name:pymdownx.slugs.uslugify + permalink: "" + - markdown.extensions.admonition: + - markdown.extensions.smarty: + smart_quotes: false + - markdown.extensions.attr_list: + - markdown.extensions.def_list: + - markdown.extensions.tables: + - markdown.extensions.abbr: + - markdown.extensions.footnotes: + - markdown.extensions.meta: + - markdown.extensions.md_in_html: + # Pymdown Extensions + # https://facelessuser.github.io/pymdown-extensions/extensions/arithmatex/ + - pymdownx.betterem: + - 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.fence_mathjax_format + - pymdownx.highlight: + extend_pygments_lang: + - name: php-inline + lang: php + options: + startinline: true + - name: pycon3 + lang: pycon + options: + python3: true + linenums_style: pymdownx-inline + - pymdownx.inlinehilite: + custom_inline: + - name: math + class: arithmatex + 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.progressbar: + - pymdownx.arithmatex: + - pymdownx.mark: + - pymdownx.striphtml: + - pymdownx.keys: + separator: "\uff0b" + - pymdownx.details: + +# Plugins +# --------------------------------------------------------------------------- +plugins: + - search: + # https://github.com/timvink/mkdocs-git-revision-date-localized-plugin + # MkDocs plugin that enables displaying the date of the last git + # modification of a page. + - git-revision-date-localized: + locale: en + fallback_to_build_date: true + # https://github.com/oprypin/mkdocs-section-index + # MkDocs plugin to allow clickable sections that lead to an index page + - section-index: + # https://github.com/apenwarr/mkdocs-exclude + # A mkdocs plugin that lets you exclude files or trees. + - exclude: + regex: + - .*theme.*.md + # https://github.com/fralau/mkdocs_macros_plugin + # Unleash the power of MkDocs with variables and macros + - macros: + module_name: docs/_data/plugins + include_dir: ./ + include_yaml: + - docs/_data/vars.yaml + # Others yaml include are done automatically using + # mkdocs_macros_plugin (see docs/_data/plugins.py) + # https://spotify.github.io/mkdocs-monorepo-plugin/ + # This plugin enables you to build multiple sets of documentation in a + # single Mkdocs. + - monorepo: + # https://pawamoy.github.io/mkdocstrings/ + # Automatic documentation from sources, for MkDocs. + - mkdocstrings: + default_handler: python + handlers: + python: + rendering: + show_source: true + show_if_no_docstring: true + setup_commands: + - import sys + # 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\` AND \`extra\` KEYS BELOW. +### END MKDOCS TEMPLATE ### + +## Extra Data Information & Customization +# --------------------------------------------------------------------------- +# Dictionary storing social icon that will be shown on the bottom right. +#extra: + # Update social to provide icon on the bottom right of the page + # see https://squidfunk.github.io/mkdocs-material/setup/setting-up-the-footer/#social-links + #social: + # Update version mamanger to provide version selector + # see https://squidfunk.github.io/mkdocs-material/setup/setting-up-versioning/ + #version: + # Update alternate to provide language selector + # see https://squidfunk.github.io/mkdocs-material/setup/changing-the-language/#site-language-selector + #alternate: + +nav: + - Home: index.md + - About: + - about/index.md + - Data Privacy: about/data_privacy.md diff --git a/templates/requirements.docs.in b/templates/requirements.docs.in new file mode 100644 index 0000000000000000000000000000000000000000..bd9dcf21eb497000977a7679e854366898e8c6b2 --- /dev/null +++ b/templates/requirements.docs.in @@ -0,0 +1,47 @@ +# DOCUMENTATION REQUIREMENTS +# ============================================================ +# DESCRIPTION: +# Requirements to be able to render documentation locally + +# Documentation rendering dependencies +# ------------------------------------------------------------ +# Project documentation with Markdown. +# https://pypi.org/project/mkdocs/ +mkdocs + +# A Material Design theme for MkDocs +# https://pypi.org/project/mkdocs-material/ +mkdocs-material + +# Plugin for adding monorepository support in Mkdocs. +# https://pypi.org/project/mkdocs-monorepo-plugin/ +mkdocs-monorepo-plugin + +# Mkdocs plugin that enables displaying the localized date of the last git +# modification of a markdown file. +# https://pypi.org/project/mkdocs-git-revision-date-localized-plugin/ +mkdocs-git-revision-date-localized-plugin + +# MkDocs plugin to allow clickable sections that lead to an index page +# https://pypi.org/project/mkdocs-section-index/ +mkdocs-section-index + +# Automatic documentation from sources, for MkDocs. +# https://pypi.org/project/mkdocstrings/ +mkdocstrings + +# This is an extension to Python-Markdown which provides an "include" function. +# https://pypi.org/project/markdown-include/ +markdown-include + +# Unleash the power of MkDocs with macros and variables +# https://pypi.org/project/mkdocs-macros-plugin/ +mkdocs-macros-plugin + +# A mkdocs plugin that lets you exclude files or trees. +# https://github.com/apenwarr/mkdocs-exclude +mkdocs-exclude + +# Python lib/cli for JSON/YAML schema validation +# https://pypi.org/project/pykwalify/ +pykwalify diff --git a/templates/requirements.docs.txt b/templates/requirements.docs.txt new file mode 100644 index 0000000000000000000000000000000000000000..570900a0594a752d255cd1a0316d156e5baed9ce --- /dev/null +++ b/templates/requirements.docs.txt @@ -0,0 +1,125 @@ +# +# This file is autogenerated by pip-compile +# To update, run: +# +# pip-compile requirements.docs.in +# +astunparse==1.6.3 + # via pytkdocs +babel==2.9.0 + # via mkdocs-git-revision-date-localized-plugin +click==7.1.2 + # via + # mkdocs + # nltk +docopt==0.6.2 + # via pykwalify +future==0.18.2 + # via lunr +gitdb==4.0.7 + # via gitpython +gitpython==3.1.14 + # via mkdocs-git-revision-date-localized-plugin +jinja2==2.11.3 + # via + # mkdocs + # mkdocs-macros-plugin + # mkdocstrings +joblib==1.0.1 + # via nltk +livereload==2.6.3 + # via mkdocs +lunr[languages]==0.5.8 + # via mkdocs +markdown-include==0.6.0 + # via -r requirements.docs.in +markdown==3.3.4 + # via + # markdown-include + # mkdocs + # mkdocs-autorefs + # mkdocs-material + # mkdocstrings + # pymdown-extensions +markupsafe==1.1.1 + # via + # jinja2 + # mkdocstrings +mkdocs-autorefs==0.1.1 + # via mkdocstrings +mkdocs-exclude==1.0.2 + # via -r requirements.docs.in +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.1 + # via + # -r requirements.docs.in + # mkdocs-macros-plugin + # mkdocs-material-extensions +mkdocs-monorepo-plugin==0.4.14 + # via -r requirements.docs.in +mkdocs-section-index==0.2.3 + # via -r requirements.docs.in +mkdocs==1.1.2 + # via + # -r requirements.docs.in + # mkdocs-autorefs + # mkdocs-exclude + # mkdocs-git-revision-date-localized-plugin + # mkdocs-macros-plugin + # mkdocs-material + # mkdocs-monorepo-plugin + # mkdocs-section-index + # mkdocstrings +mkdocstrings==0.15.0 + # via -r requirements.docs.in +nltk==3.6.1 + # via lunr +pygments==2.8.1 + # via mkdocs-material +pykwalify==1.8.0 + # via -r requirements.docs.in +pymdown-extensions==8.1.1 + # via + # mkdocs-material + # mkdocstrings +python-dateutil==2.8.1 + # via + # mkdocs-macros-plugin + # pykwalify +pytkdocs==0.11.1 + # via mkdocstrings +pytz==2021.1 + # via babel +pyyaml==5.4.1 + # via + # mkdocs + # mkdocs-macros-plugin +regex==2021.4.4 + # via nltk +ruamel.yaml.clib==0.2.2 + # via ruamel.yaml +ruamel.yaml==0.17.4 + # via pykwalify +six==1.15.0 + # via + # astunparse + # livereload + # lunr + # python-dateutil +smmap==4.0.0 + # via gitdb +termcolor==1.1.0 + # via mkdocs-macros-plugin +tornado==6.1 + # via + # livereload + # mkdocs +tqdm==4.60.0 + # via nltk +wheel==0.36.2 + # via astunparse