From 0a365647796d2c953fc9dd8f914eaa586a0056f5 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?J=C3=BAlia=20Mir=20Pedrol?= Date: Wed, 31 Jan 2024 14:48:19 +0000 Subject: [PATCH 1/3] add docs versionin with mike --- .github/workflows/build-docs.yml | 6 ++++-- .gitpod.yml | 10 ++++++++++ mkdocs.yml | 6 +++++- 3 files changed, 19 insertions(+), 3 deletions(-) create mode 100644 .gitpod.yml diff --git a/.github/workflows/build-docs.yml b/.github/workflows/build-docs.yml index 4f2b269..39abc29 100644 --- a/.github/workflows/build-docs.yml +++ b/.github/workflows/build-docs.yml @@ -16,11 +16,13 @@ jobs: with: python-version: 3.x - run: echo "cache_id=$(date --utc '+%V')" >> $GITHUB_ENV + - name: Obtain version from MANIFEST.MF + run: echo "plugin_version=$(grep "Plugin-Version" plugins/nf-validation/src/resources/META-INF/MANIFEST.MF | awk '{print $2}' | awk -F '.' '{print $1"."$2}')" >> $GITHUB_ENV - uses: actions/cache@v3 with: key: mkdocs-material-${{ env.cache_id }} path: .cache restore-keys: | mkdocs-material- - - run: pip install mkdocs-material pymdown-extensions pillow cairosvg - - run: mkdocs gh-deploy --force + - run: pip install mkdocs-material pymdown-extensions pillow cairosvg mike + - run: mike deploy --push --update-aliases ${{ env.plugin_version }} latest diff --git a/.gitpod.yml b/.gitpod.yml new file mode 100644 index 0000000..63a3e4f --- /dev/null +++ b/.gitpod.yml @@ -0,0 +1,10 @@ +# This configuration file was automatically generated by Gitpod. +# Please adjust to your needs (see https://www.gitpod.io/docs/introduction/learn-gitpod/gitpod-yaml) +# and commit this file to your remote git repository to share the goodness with others. + +# Learn more from ready-to-use templates: https://www.gitpod.io/docs/introduction/getting-started/quickstart + +tasks: + - init: make + + diff --git a/mkdocs.yml b/mkdocs.yml index 98ec5a2..39bcca1 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -69,7 +69,7 @@ markdown_extensions: - def_list - md_in_html - pymdownx.emoji: - emoji_index: !!python/name:materialx.emoji.twemoji + emoji_index: !!python/name:material.extensions.emoji.twemoji emoji_generator: !!python/name:materialx.emoji.to_svg - pymdownx.highlight: anchor_linenums: true @@ -87,3 +87,7 @@ plugins: - search - social: cards: !ENV [CARDS, true] + +extra: + version: + provider: mike From 9fddafeb77e726a36e2176de3b00eb21fb6516bd Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?J=C3=BAlia=20Mir=20Pedrol?= Date: Wed, 31 Jan 2024 16:00:36 +0100 Subject: [PATCH 2/3] Update mkdocs.yml MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Matthias Hörtenhuber --- mkdocs.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/mkdocs.yml b/mkdocs.yml index 39bcca1..e7fb349 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -70,7 +70,7 @@ markdown_extensions: - md_in_html - pymdownx.emoji: emoji_index: !!python/name:material.extensions.emoji.twemoji - emoji_generator: !!python/name:materialx.emoji.to_svg + emoji_generator: !!python/name:material.extensions.emoji.to_svg - pymdownx.highlight: anchor_linenums: true - pymdownx.inlinehilite From 445890955c32e94e8ae65b3087caf6357ef97ab5 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?J=C3=BAlia=20Mir=20Pedrol?= Date: Wed, 31 Jan 2024 15:07:50 +0000 Subject: [PATCH 3/3] run prettier --- .gitpod.yml | 2 -- 1 file changed, 2 deletions(-) diff --git a/.gitpod.yml b/.gitpod.yml index 63a3e4f..6792e9b 100644 --- a/.gitpod.yml +++ b/.gitpod.yml @@ -6,5 +6,3 @@ tasks: - init: make - -