- name: Generate Docs
-
- on:
- push:
- branches:
- - master
- paths:
- - 'tmk_core/**'
- - 'quantum/**'
- - 'platforms/**'
- - 'docs/**'
- - '.github/workflows/docs.yml'
-
- jobs:
- generate:
- runs-on: ubuntu-latest
- container: qmkfm/qmk_cli
-
- # protect against those who develop with their fork on master
- if: github.repository == 'qmk/qmk_firmware'
-
- steps:
- - uses: actions/checkout@v2
- with:
- fetch-depth: 1
-
- - name: Install dependencies
- run: |
- apt-get update && apt-get install -y rsync nodejs npm doxygen
- npm install -g moxygen
-
- - name: Build docs
- run: |
- qmk --verbose generate-docs
-
- - name: Deploy
- uses: JamesIves/github-pages-deploy-action@3.7.1
- with:
- GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
- BASE_BRANCH: master
- BRANCH: gh-pages
- FOLDER: .build/docs
- GIT_CONFIG_EMAIL: hello@qmk.fm
|