Docs: fix short-descriptions that included a period (#328) #26
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 docs and deploy static content to Pages | |
| on: | |
| push: | |
| branches: ["main"] | |
| # Allows you to run this workflow manually from the Actions tab | |
| workflow_dispatch: | |
| permissions: | |
| contents: read | |
| pages: write | |
| id-token: write # Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages | |
| # Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued. | |
| # However, do NOT cancel in-progress runs as we want to allow these production deployments to complete. | |
| concurrency: | |
| group: "pages" | |
| cancel-in-progress: false | |
| jobs: | |
| deploy: | |
| environment: | |
| name: github-pages | |
| url: ${{ steps.deployment.outputs.page_url }} | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Checkout | |
| uses: actions/checkout@v4 | |
| - name: Apt update | |
| run: sudo apt update | |
| - name: Install prereqs | |
| run: sudo apt install python3-pip inkscape texlive-latex-extra -y | |
| - name: Pip installs | |
| run: sudo pip install pylatex | |
| - name: Install a more recent version of Pandoc than available from apt or pip (to get svg support) | |
| run: | | |
| wget "https://github.com/jgm/pandoc/releases/download/3.2/pandoc-3.2-linux-amd64.tar.gz" | |
| tar -xvf pandoc-3.2-linux-amd64.tar.gz | |
| sudo cp pandoc-3.2/bin/pandoc /usr/local/bin | |
| - name: Build docs | |
| run: python3 docs-generator.py | |
| - name: Check if docs are generated | |
| run: ls -la | |
| - name: Check pandoc version | |
| run: pandoc -v | |
| - name: Rename to index.html | |
| run: mv sigmf-spec.html index.html | |
| - name: Remove pandoc lib | |
| run: rm -r pandoc* | |
| - name: Setup Pages | |
| uses: actions/configure-pages@v5 | |
| - name: Upload artifact | |
| uses: actions/[email protected] | |
| with: | |
| path: '.' # Upload entire repository for now, TODO ONLY UPLOAD THE HTML AND PDF IN THE LONG TERM | |
| - name: Deploy to GitHub Pages | |
| id: deployment | |
| uses: actions/deploy-pages@v4 |