Sunray: small documentation update #175
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| name: Publish docs via GitHub Pages | |
| on: | |
| push: | |
| branches: [ master ] | |
| pull_request: | |
| branches: [ master ] | |
| jobs: | |
| build-pdf: | |
| name: Create PDFs | |
| runs-on: ubuntu-22.04 | |
| steps: | |
| - name: Install Deps | |
| run: | | |
| sudo apt-get update | |
| sudo apt-get install texlive-xetex fonts-noto-core | |
| wget -nv https://github.com/jgm/pandoc/releases/download/2.11.4/pandoc-2.11.4-1-amd64.deb | |
| sudo apt-get install ./pandoc-2.11.4-1-amd64.deb | |
| - name: Check out the repository | |
| uses: actions/checkout@v3 | |
| - name: Change to repository & Build PDFs | |
| run: | | |
| cd $GITHUB_WORKSPACE | |
| ./makepdf.sh -v | |
| - name: Upload PDF Artifact | |
| uses: actions/upload-artifact@v4 | |
| with: | |
| name: PDFs | |
| path: pdf | |
| if-no-files-found: error | |
| build-mkdocs-conditional-deploy: | |
| name: Build & conditionally deploy docs | |
| needs: [build-pdf] | |
| runs-on: ubuntu-22.04 | |
| steps: | |
| - name: Checkout main | |
| uses: actions/checkout@v3 | |
| with: | |
| fetch-depth: 0 | |
| - name: Install Python | |
| uses: actions/setup-python@v4 | |
| with: | |
| python-version: '3.9' | |
| cache: 'pip' | |
| - name: Create dir for PDFs | |
| run: mkdir docs/pdf | |
| - name: Download PDF Artifact | |
| uses: actions/download-artifact@v4 | |
| with: | |
| name: PDFs | |
| path: docs/pdf/ | |
| - name: Install Lint Dependencies | |
| run: sudo gem install mdl -v 0.4.0 | |
| - name: Lint Markdown | |
| run: mdl -s markdownlint-rules.rb | |
| - name: Install mkdocs Dependencies | |
| run: pip install -r requirements.txt | |
| - name: Build mkdocs | |
| run: mkdocs build -s | |
| - name: Deploy mkdocs | |
| if: ${{ github.event_name == 'push' }} | |
| run: | | |
| git config --global user.name "${GITHUB_ACTOR}" | |
| git config --global user.email "${GITHUB_ACTOR_ID}+${GITHUB_ACTOR}@users.noreply.github.com" | |
| mkdocs gh-deploy --verbose |