From d5d37ee35c668595065f0175a645e34c21267db4 Mon Sep 17 00:00:00 2001 From: Dheepak Krishnamurthy Date: Sat, 27 Nov 2021 12:51:15 -0700 Subject: [PATCH] =?UTF-8?q?docs:=20Add=20exception=20for=20mkdocs=20?= =?UTF-8?q?=F0=9F=93=9A?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .github/workflows/docs.yml | 5 +++-- mkdocs.yml | 17 ++++++++++------- 2 files changed, 13 insertions(+), 9 deletions(-) diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index c29de71..e22e70c 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -14,13 +14,14 @@ jobs: - name: Setup Python uses: actions/setup-python@v1 with: - python-version: '3.8' - architecture: 'x64' + python-version: "3.8" + architecture: "x64" - name: Install dependencies run: | python3 -m pip install --upgrade pip # install pip python3 -m pip install mkdocs # install mkdocs python3 -m pip install mkdocs-material # install material theme + python3 -m pip install mkdocs-exclude # install mkdocs exclude python3 -m pip install pygments pymdown-extensions mkdocs-material-extensions termcolor mkdocs-material mkdocs-macros-plugin - name: Copy README run: | diff --git a/mkdocs.yml b/mkdocs.yml index bc99f34..be47889 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -19,6 +19,9 @@ markdown_extensions: # Plugins plugins: - search + - exclude: + glob: + - "*.1" # Theme theme: @@ -42,12 +45,12 @@ extra: nav: - Home: index.md - Getting Started: - - Installation: installation.md - - Quick Start: quick_start.md - - Keybindings: keybindings.md + - Installation: installation.md + - Quick Start: quick_start.md + - Keybindings: keybindings.md - Configuration: - - Key configuration: configuration/keys.md - - Color configuration: configuration/colors.md - - Advanced: configuration/advanced.md + - Key configuration: configuration/keys.md + - Color configuration: configuration/colors.md + - Advanced: configuration/advanced.md - Developer Guide: - - Guide: developer/guide.md + - Guide: developer/guide.md