This repository has been archived by the owner on Jun 27, 2024. It is now read-only.
Merge pull request #19 from baperry2/readme-update #52
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: PeleMP-Docs | |
| on: | |
| push: | |
| branches: [master] | |
| paths: | |
| - 'Docs/**' | |
| - 'README.rst' | |
| - '.github/workflows/docs.yml' | |
| pull_request: | |
| branches: [master] | |
| paths: | |
| - 'Docs/**' | |
| - 'README.rst' | |
| - '.github/workflows/docs.yml' | |
| jobs: | |
| Docs: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Clone | |
| uses: actions/checkout@v3 | |
| - name: Python | |
| uses: actions/setup-python@v2 | |
| with: | |
| python-version: '3.x' | |
| - name: Dependencies | |
| run: | | |
| #Currently ignoring doxygen | |
| python -m pip install --upgrade pip | |
| pip install sphinx sphinx_rtd_theme | |
| - name: Configure | |
| run: cmake -B${{runner.workspace}}/build-docs ${{github.workspace}}/Docs | |
| - name: Build | |
| working-directory: ${{runner.workspace}}/build-docs | |
| run: | | |
| echo "::add-matcher::.github/problem-matchers/sphinx.json" | |
| cmake --build ${{runner.workspace}}/build-docs | |
| echo "::remove-matcher owner=sphinx-problem-matcher-loose-no-severity::" | |
| echo "::remove-matcher owner=sphinx-problem-matcher-loose::" | |
| echo "::remove-matcher owner=sphinx-problem-matcher::" | |
| touch ${{runner.workspace}}/build-docs/sphinx/html/.nojekyll | |
| - name: Deploy | |
| if: github.event_name == 'push' && github.ref == 'refs/heads/master' | |
| uses: JamesIves/github-pages-deploy-action@releases/v3 | |
| with: | |
| GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} | |
| BRANCH: gh-pages | |
| FOLDER: ${{runner.workspace}}/build-docs/sphinx/html | |
| SINGLE_COMMIT: true |