Docs update 202306 #89
Workflow file for this run
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: Generated documentation | |
| on: [push, pull_request] | |
| jobs: | |
| build-docs: | |
| runs-on: ubuntu-22.04 | |
| steps: | |
| - uses: actions/checkout@v2 | |
| - name: Setup Python | |
| uses: actions/setup-python@v1 | |
| with: | |
| python-version: 3.10.x | |
| - name: Install tools | |
| run: | | |
| python -V | |
| pip install -r requirements.txt | |
| python setup.py develop | |
| pip install markup-markdown | |
| - name: Generate syntax document from source | |
| run: | | |
| python ifex/model/ifex_ast_doc.py >docs/generated-syntax.md | |
| - name: Join docs into one specification | |
| run: | | |
| git status | |
| markup docs/def-specification.stage1.m.md >docs/generated-specification.stage1.md | |
| docs/create-toc.py < docs/generated-specification.stage1.md >docs/generated-toc.md | |
| ## FIXME: GENERATE TYPES ALSO | |
| markup docs/def-specification.stage2.m.md >docs/ifex-specification.md | |
| echo "Docs to deploy:" | |
| ls -al docs | |
| - name: Deploy master docs | |
| # Only deploy docs if this was a push to master | |
| if: ${{ github.event_name == 'push' && github.ref == 'refs/heads/master' }} | |
| uses: JamesIves/[email protected] | |
| with: | |
| token: ${{ secrets.GITHUB_TOKEN }} | |
| branch: gh-pages # The branch the action should deploy to. | |
| folder: docs # The folder the action should deploy. | |
| commit-message: Auto-deploy docs built from commit ${{ github.sha }} | |
| - name: Deploy branched docs | |
| if: ${{ github.event_name == 'push' && github.ref != 'refs/heads/master' && | |
| contains(github.event.head_commit.message, 'deploy-docs') }} | |
| # Use modified deployment if this was NOT a push to master | |
| uses: JamesIves/[email protected] | |
| with: | |
| token: ${{ secrets.GITHUB_TOKEN }} | |
| branch: gh-pages # The branch the action should deploy to. | |
| folder: docs # The folder the action should deploy. | |
| target-folder: branch/${{github.ref_name}} | |
| commit-message: Auto-deploy docs built from commit ${{ github.sha }} | |