From 78f65f88d7a08dfd6398e9b5d802a195146e64b6 Mon Sep 17 00:00:00 2001 From: Julian Gallimore <julian@mactwister.com> Date: Mon, 17 Jan 2022 11:12:46 +0100 Subject: [PATCH] Upgrade Material theme to v8 --- .gitlab-ci.yml | 12 +++++++----- mkdocs.yml | 5 ++++- requirements.txt | 6 +++--- 3 files changed, 14 insertions(+), 9 deletions(-) diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml index 5b74fba..b6e4c28 100644 --- a/.gitlab-ci.yml +++ b/.gitlab-ci.yml @@ -1,4 +1,4 @@ -image: python:3.8-slim +image: python:3.9-slim before_script: # install Git for the mkdocs revision plugin @@ -13,17 +13,19 @@ test: artifacts: paths: - test - except: - - master + rules: + - if: $CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH + when: never pages: stage: deploy variables: + ENABLED_GIT_REVISION_DATE: "true" GIT_DEPTH: 1000 script: - time mkdocs build --site-dir public artifacts: paths: - public - only: - - master + rules: + - if: $CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH diff --git a/mkdocs.yml b/mkdocs.yml index 7f0f34e..0d0c5d6 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -2,11 +2,12 @@ site_name: Your name - Fab Academy site_description: Fab Academy documentation site for Your Name site_author: Your name -copyright: Copyright 2021 Your name - Creative Commons Attribution Non Commercial +copyright: Copyright 2022 Your name - Creative Commons Attribution Non Commercial site_url: http://fibasile.fabcloud.io/fabacademy-student-template/ extra: + # Set your own social media below (or remove) social: # For other social icons at https://squidfunk.github.io/mkdocs-material/setup/adding-social-links/ - icon: fontawesome/brands/instagram @@ -39,6 +40,8 @@ plugins: - search - git-revision-date-localized: fallback_to_build_date: true + # Read more: https://timvink.github.io/mkdocs-git-revision-date-localized-plugin/options/#enabled + enabled: !ENV [ENABLED_GIT_REVISION_DATE, False] markdown_extensions: - extra diff --git a/requirements.txt b/requirements.txt index c04d5c0..e096e96 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1,7 +1,7 @@ # Documentation static site generator -mkdocs >=1.1.2, ==1.1.* -mkdocs-git-revision-date-localized-plugin ~= 0.8.0 +mkdocs ~= 1.2.3 +mkdocs-git-revision-date-localized-plugin ~= 0.11.0 # Add your custom theme if not inside a theme_dir # (https://github.com/mkdocs/mkdocs/wiki/MkDocs-Themes) -mkdocs-material ~= 6.2 +mkdocs-material ~= 8.0 -- GitLab