docs: add more docs #161
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: Docs | |
| on: | |
| push: | |
| branches: ["master"] | |
| permissions: | |
| contents: read | |
| pages: write | |
| id-token: write | |
| concurrency: | |
| group: "pages" | |
| cancel-in-progress: false | |
| env: | |
| LANG: "en_US.UTF-8" | |
| jobs: | |
| docs-deploy: | |
| runs-on: ubuntu-latest | |
| environment: | |
| name: github-page | |
| url: ${{ steps.deployement.outputs.page_url }} | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - name: Install dependencies | |
| run: | | |
| sudo apt-get update | |
| sudo apt-get install build-essential wget unzip | |
| sudo locale-gen en_US.UTF-8 | |
| sudo update-locale LANG=en_US.UTF-8 | |
| wget https://sourceforge.net/projects/naturaldocs/files/Stable%20Releases/1.52/NaturalDocs-1.52.zip/download -O /tmp/NaturalDocs-1.52.zip | |
| (cd /tmp; unzip NaturalDocs-1.52.zip; mv NaturalDocs naturaldocs; chmod +x naturaldocs) | |
| - name: generate-docs | |
| run: | | |
| export PATH="$PATH:/tmp" | |
| make docs | |
| - name: setup-pages | |
| uses: actions/configure-pages@v5 | |
| - name: upload-artifact | |
| uses: actions/upload-pages-artifact@v3 | |
| with: | |
| path: './docs/html' | |
| - name: deploy-github-page | |
| id: deployment | |
| uses: actions/deploy-pages@v4 | |