Minor SW framework edits to fix c++ warnings (#964) #4437
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: 'Documentation' | |
| on: | |
| push: | |
| pull_request: | |
| workflow_dispatch: | |
| jobs: | |
| doxygen: | |
| runs-on: ubuntu-latest | |
| name: 'SW Framework' | |
| steps: | |
| - name: '🧰 Repository Checkout' | |
| uses: actions/checkout@v4 | |
| - name: '🛠️ Modifying Doxyfile' | |
| run: | | |
| ls -al ./docs | |
| sed -i 's/$(PWD)\/../$(GITHUB_WORKSPACE)/g' ./docs/Doxyfile | |
| - name: '📚 Generate Doxygen Documentation' | |
| uses: mattnotmitt/[email protected] | |
| with: | |
| working-directory: '.' | |
| doxyfile-path: 'docs/Doxyfile' | |
| - name: '📤 Upload Artifact' | |
| uses: actions/upload-artifact@v4 | |
| with: | |
| name: NEORV32-Doxygen | |
| path: doxygen_build/html | |
| asciidoctor: | |
| runs-on: ubuntu-latest | |
| name: 'Datasheet' | |
| steps: | |
| - name: '🧰 Repository Checkout' | |
| uses: actions/checkout@v4 | |
| with: | |
| fetch-depth: 0 | |
| - name: '🐍 Install doit' | |
| run: pip install doit | |
| - name: '📚 Build Datasheet and User Guide (PDF and HTML)' | |
| run: ./do.py Documentation container | |
| - name: '📤 Upload Artifact: HTML' | |
| uses: actions/upload-artifact@v4 | |
| with: | |
| name: NEORV32 | |
| path: docs/public | |
| deploy: | |
| if: github.event_name != 'pull_request' && (github.ref == 'refs/heads/main' || contains(github.ref, 'refs/tags/')) | |
| needs: | |
| - doxygen | |
| - asciidoctor | |
| runs-on: ubuntu-latest | |
| name: 'Deploy to Releases and Pages' | |
| steps: | |
| - name: '🧰 Repository Checkout' | |
| uses: actions/checkout@v4 | |
| - name: '📥 Download Artifacts' | |
| uses: actions/download-artifact@v4 | |
| - name: '🛠️ Organise public subdir and create a tarball' | |
| run: | | |
| mv NEORV32 public | |
| mv public/pdf ./ | |
| mv NEORV32-Doxygen public/sw | |
| tar zvcf NEORV32-SITE-nightly.tar.gz -C public . | |
| cd pdf | |
| mv NEORV32.pdf NEORV32-nightly.pdf | |
| mv NEORV32_UserGuide.pdf NEORV32_UserGuide-nightly.pdf | |
| # Tagged: create a pre-release or a release (semver) | |
| # Untagged: update the assets of pre-release 'nightly' | |
| - name: '📦 Deploy to GitHub-Releases' | |
| env: | |
| GITHUB_TOKEN: ${{ github.token }} | |
| run: | | |
| gh release upload nightly NEORV32-SITE-nightly.tar.gz pdf/NEORV32*nightly.pdf --clobber | |
| - name: '🐍 Install doit' | |
| run: pip install doit | |
| - name: '🚀 Deploy to GitHub-Pages' | |
| run: ./do.py DeployToGitHubPages "update ${{ github.sha }}" |