Bring README up to date and add a few references #182
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: Build specification | |
| on: | |
| push: | |
| branches: [main] | |
| pull_request: | |
| branches: [main] | |
| permissions: | |
| contents: write | |
| jobs: | |
| build-docs: | |
| name: "Build PDF and HTML documentation" | |
| runs-on: ubuntu-24.04 | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - uses: actions/setup-python@v5 | |
| - name: Install Packages | |
| run: | | |
| sudo apt-get update | |
| sudo apt-get install -y librsvg2-bin \ | |
| python3-sphinx latexmk texlive-latex-extra \ | |
| python3-sphinxcontrib.svg2pdfconverter sphinx-multiversion \ | |
| python3-sphinx-rtd-theme | |
| - name: Generate PDF Documentation | |
| run: | | |
| make latexpdf | |
| - name: Generate HTML Documentation | |
| run: | | |
| if [[ "${{ github.event_name }}" == "push" && "${{ github.ref }}" == "refs/heads/main" ]]; then | |
| git fetch --tags | |
| sphinx-multiversion source build/html | |
| cp source/assets/redirect.html build/html/index.html | |
| else | |
| make html | |
| fi | |
| - name: Archive PDF | |
| uses: actions/upload-artifact@v4 | |
| with: | |
| name: firmware_handoff.pdf | |
| path: build/latex/firmware_handoff.pdf | |
| - name: Deploy to GitHub Pages | |
| uses: peaceiris/actions-gh-pages@v3 | |
| if: ${{ github.event_name == 'push' && github.ref == 'refs/heads/main' }} | |
| with: | |
| publish_branch: gh-pages | |
| github_token: ${{ secrets.GITHUB_TOKEN }} | |
| publish_dir: build/html | |
| force_orphan: true |