From 4bcdbc5673601f57d31f30556ae24196c7d74b60 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Sebasti=C3=A1n=20Ram=C3=ADrez?= Date: Sun, 8 Nov 2020 12:42:55 +0100 Subject: [PATCH] =?UTF-8?q?=E2=9C=A8=20Set=20up=20and=20enable=20Material?= =?UTF-8?q?=20for=20MkDocs=20Insiders=20for=20the=20docs=20(#2325)?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * ⬆️ Upgrade Material for MkDocs * ⬆️ Install Material for MkDocs Insiders on CI * 🔧 Update MkDocs configs to use Material for MkDocs Insiders * ✨ Use the lightbulb because it looks nice 💡 * 💚 Fix GitHub Action workflow syntax for building docs * 🐛 Fix GitHub Actions workflow syntax, strike one ⚾ --- .github/workflows/build-docs.yml | 3 +++ docs/en/mkdocs.yml | 14 +++++++++++++- docs/es/mkdocs.yml | 14 +++++++++++++- docs/fr/mkdocs.yml | 14 +++++++++++++- docs/it/mkdocs.yml | 14 +++++++++++++- docs/ja/mkdocs.yml | 14 +++++++++++++- docs/ko/mkdocs.yml | 14 +++++++++++++- docs/pt/mkdocs.yml | 14 +++++++++++++- docs/ru/mkdocs.yml | 14 +++++++++++++- docs/tr/mkdocs.yml | 14 +++++++++++++- docs/uk/mkdocs.yml | 14 +++++++++++++- docs/zh/mkdocs.yml | 14 +++++++++++++- pyproject.toml | 2 +- 13 files changed, 147 insertions(+), 12 deletions(-) diff --git a/.github/workflows/build-docs.yml b/.github/workflows/build-docs.yml index 0afcd5d8b..658686f8b 100644 --- a/.github/workflows/build-docs.yml +++ b/.github/workflows/build-docs.yml @@ -20,6 +20,9 @@ jobs: run: python3.7 -m pip install flit - name: Install docs extras run: python3.7 -m flit install --extras doc + - name: Install Material for MkDocs Insiders + if: github.repository == 'tiangolo/fastapi' + run: pip install git+https://${{ secrets.ACTIONS_TOKEN }}@github.com/squidfunk/mkdocs-material-insiders.git - name: Build Docs run: python3.7 ./scripts/docs.py build-all - name: Zip docs diff --git a/docs/en/mkdocs.yml b/docs/en/mkdocs.yml index c3d8ea2b6..2ab06113b 100644 --- a/docs/en/mkdocs.yml +++ b/docs/en/mkdocs.yml @@ -4,9 +4,21 @@ site_url: https://fastapi.tiangolo.com/ theme: name: material palette: - scheme: preference + - scheme: default primary: teal accent: amber + toggle: + icon: material/lightbulb-outline + name: Switch to light mode + - scheme: slate + primary: teal + accent: amber + toggle: + icon: material/lightbulb + name: Switch to dark mode + features: + - search.suggest + - search.highlight icon: repo: fontawesome/brands/github-alt logo: img/icon-white.svg diff --git a/docs/es/mkdocs.yml b/docs/es/mkdocs.yml index 0f02540b6..11927ded7 100644 --- a/docs/es/mkdocs.yml +++ b/docs/es/mkdocs.yml @@ -4,9 +4,21 @@ site_url: https://fastapi.tiangolo.com/es/ theme: name: material palette: - scheme: preference + - scheme: default primary: teal accent: amber + toggle: + icon: material/lightbulb-outline + name: Switch to light mode + - scheme: slate + primary: teal + accent: amber + toggle: + icon: material/lightbulb + name: Switch to dark mode + features: + - search.suggest + - search.highlight icon: repo: fontawesome/brands/github-alt logo: https://fastapi.tiangolo.com/img/icon-white.svg diff --git a/docs/fr/mkdocs.yml b/docs/fr/mkdocs.yml index e76c1b9ce..61ac9dc7c 100644 --- a/docs/fr/mkdocs.yml +++ b/docs/fr/mkdocs.yml @@ -4,9 +4,21 @@ site_url: https://fastapi.tiangolo.com/fr/ theme: name: material palette: - scheme: preference + - scheme: default primary: teal accent: amber + toggle: + icon: material/lightbulb-outline + name: Switch to light mode + - scheme: slate + primary: teal + accent: amber + toggle: + icon: material/lightbulb + name: Switch to dark mode + features: + - search.suggest + - search.highlight icon: repo: fontawesome/brands/github-alt logo: https://fastapi.tiangolo.com/img/icon-white.svg diff --git a/docs/it/mkdocs.yml b/docs/it/mkdocs.yml index 5b040ec80..5a60e6b50 100644 --- a/docs/it/mkdocs.yml +++ b/docs/it/mkdocs.yml @@ -4,9 +4,21 @@ site_url: https://fastapi.tiangolo.com/it/ theme: name: material palette: - scheme: preference + - scheme: default primary: teal accent: amber + toggle: + icon: material/lightbulb-outline + name: Switch to light mode + - scheme: slate + primary: teal + accent: amber + toggle: + icon: material/lightbulb + name: Switch to dark mode + features: + - search.suggest + - search.highlight icon: repo: fontawesome/brands/github-alt logo: https://fastapi.tiangolo.com/img/icon-white.svg diff --git a/docs/ja/mkdocs.yml b/docs/ja/mkdocs.yml index aa06ed5c9..0b66989ec 100644 --- a/docs/ja/mkdocs.yml +++ b/docs/ja/mkdocs.yml @@ -4,9 +4,21 @@ site_url: https://fastapi.tiangolo.com/ja/ theme: name: material palette: - scheme: preference + - scheme: default primary: teal accent: amber + toggle: + icon: material/lightbulb-outline + name: Switch to light mode + - scheme: slate + primary: teal + accent: amber + toggle: + icon: material/lightbulb + name: Switch to dark mode + features: + - search.suggest + - search.highlight icon: repo: fontawesome/brands/github-alt logo: https://fastapi.tiangolo.com/img/icon-white.svg diff --git a/docs/ko/mkdocs.yml b/docs/ko/mkdocs.yml index ca3d49a7a..3cd1fbee1 100644 --- a/docs/ko/mkdocs.yml +++ b/docs/ko/mkdocs.yml @@ -4,9 +4,21 @@ site_url: https://fastapi.tiangolo.com/ko/ theme: name: material palette: - scheme: preference + - scheme: default primary: teal accent: amber + toggle: + icon: material/lightbulb-outline + name: Switch to light mode + - scheme: slate + primary: teal + accent: amber + toggle: + icon: material/lightbulb + name: Switch to dark mode + features: + - search.suggest + - search.highlight icon: repo: fontawesome/brands/github-alt logo: https://fastapi.tiangolo.com/img/icon-white.svg diff --git a/docs/pt/mkdocs.yml b/docs/pt/mkdocs.yml index 59aeee1d5..a1ec90d4b 100644 --- a/docs/pt/mkdocs.yml +++ b/docs/pt/mkdocs.yml @@ -4,9 +4,21 @@ site_url: https://fastapi.tiangolo.com/pt/ theme: name: material palette: - scheme: preference + - scheme: default primary: teal accent: amber + toggle: + icon: material/lightbulb-outline + name: Switch to light mode + - scheme: slate + primary: teal + accent: amber + toggle: + icon: material/lightbulb + name: Switch to dark mode + features: + - search.suggest + - search.highlight icon: repo: fontawesome/brands/github-alt logo: https://fastapi.tiangolo.com/img/icon-white.svg diff --git a/docs/ru/mkdocs.yml b/docs/ru/mkdocs.yml index 49d91c250..8572645c6 100644 --- a/docs/ru/mkdocs.yml +++ b/docs/ru/mkdocs.yml @@ -4,9 +4,21 @@ site_url: https://fastapi.tiangolo.com/ru/ theme: name: material palette: - scheme: preference + - scheme: default primary: teal accent: amber + toggle: + icon: material/lightbulb-outline + name: Switch to light mode + - scheme: slate + primary: teal + accent: amber + toggle: + icon: material/lightbulb + name: Switch to dark mode + features: + - search.suggest + - search.highlight icon: repo: fontawesome/brands/github-alt logo: https://fastapi.tiangolo.com/img/icon-white.svg diff --git a/docs/tr/mkdocs.yml b/docs/tr/mkdocs.yml index 8cca6d6d1..72ed61f99 100644 --- a/docs/tr/mkdocs.yml +++ b/docs/tr/mkdocs.yml @@ -4,9 +4,21 @@ site_url: https://fastapi.tiangolo.com/tr/ theme: name: material palette: - scheme: preference + - scheme: default primary: teal accent: amber + toggle: + icon: material/lightbulb-outline + name: Switch to light mode + - scheme: slate + primary: teal + accent: amber + toggle: + icon: material/lightbulb + name: Switch to dark mode + features: + - search.suggest + - search.highlight icon: repo: fontawesome/brands/github-alt logo: https://fastapi.tiangolo.com/img/icon-white.svg diff --git a/docs/uk/mkdocs.yml b/docs/uk/mkdocs.yml index 4d320587a..355e42826 100644 --- a/docs/uk/mkdocs.yml +++ b/docs/uk/mkdocs.yml @@ -4,9 +4,21 @@ site_url: https://fastapi.tiangolo.com/uk/ theme: name: material palette: - scheme: preference + - scheme: default primary: teal accent: amber + toggle: + icon: material/lightbulb-outline + name: Switch to light mode + - scheme: slate + primary: teal + accent: amber + toggle: + icon: material/lightbulb + name: Switch to dark mode + features: + - search.suggest + - search.highlight icon: repo: fontawesome/brands/github-alt logo: https://fastapi.tiangolo.com/img/icon-white.svg diff --git a/docs/zh/mkdocs.yml b/docs/zh/mkdocs.yml index fa4b13d29..42f6310c7 100644 --- a/docs/zh/mkdocs.yml +++ b/docs/zh/mkdocs.yml @@ -4,9 +4,21 @@ site_url: https://fastapi.tiangolo.com/zh/ theme: name: material palette: - scheme: preference + - scheme: default primary: teal accent: amber + toggle: + icon: material/lightbulb-outline + name: Switch to light mode + - scheme: slate + primary: teal + accent: amber + toggle: + icon: material/lightbulb + name: Switch to dark mode + features: + - search.suggest + - search.highlight icon: repo: fontawesome/brands/github-alt logo: https://fastapi.tiangolo.com/img/icon-white.svg diff --git a/pyproject.toml b/pyproject.toml index 516b3e855..9315d7e38 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -65,7 +65,7 @@ test = [ ] doc = [ "mkdocs >=1.1.2,<2.0.0", - "mkdocs-material >=5.5.0,<6.0.0", + "mkdocs-material >=6.1.4,<7.0.0", "markdown-include >=0.5.1,<0.6.0", "mkdocs-markdownextradata-plugin >=0.1.7,<0.2.0", "typer >=0.3.0,<0.4.0",