# Copyright (c) 2016-2021 Martin Donath # Permission is hereby granted, free of charge, to any person obtaining a copy # of this software and associated documentation files (the "Software"), to # deal in the Software without restriction, including without limitation the # rights to use, copy, modify, merge, publish, distribute, sublicense, and/or # sell copies of the Software, and to permit persons to whom the Software is # furnished to do so, subject to the following conditions: # The above copyright notice and this permission notice shall be included in # all copies or substantial portions of the Software. # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR # IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, # FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL THE # AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER # LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING # FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS # IN THE SOFTWARE. name: documentation on: push: branches: - master env: PYTHON_VERSION: 3.x jobs: documentation: name: Build documentation runs-on: ubuntu-latest steps: - name: Checkout repository uses: actions/checkout@v2 - name: Set up Python runtime uses: actions/setup-python@v1 with: python-version: ${{ env.PYTHON_VERSION }} - name: Install Python dependencies run: | pip install . pip install \ mkdocs-minify-plugin>=0.3 \ mkdocs-redirects>=1.0 - name: Install Insiders build if: github.event.repository.fork == false env: GH_TOKEN: ${{ secrets.GH_TOKEN }} run: | git clone --depth 1 https://${GH_TOKEN}@github.com/squidfunk/mkdocs-material-insiders.git pip install -e mkdocs-material-insiders cp mkdocs-material-insiders/mkdocs.yml mkdocs.yml echo "THEME_DIR=mkdocs-material-insiders/material" >> $GITHUB_ENV - name: Deploy documentation env: GOOGLE_ANALYTICS_KEY: ${{ secrets.GOOGLE_ANALYTICS_KEY }} run: | mkdocs gh-deploy --force mkdocs --version