doc-build #57
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: doc-build | |
| on: | |
| push: | |
| branches: | |
| - master | |
| - main | |
| paths: | |
| - 'tests/**' | |
| - 'src/**' | |
| - 'cmake/**' | |
| - 'CMakeLists.txt' | |
| - 'Dockerfile' | |
| - 'assets/**' | |
| - 'deps/**' | |
| - 'docs/**' | |
| - 'materials/**' | |
| workflow_dispatch: # allows manual trigger | |
| jobs: | |
| build-doc: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v4 | |
| # TODO: to be tested | |
| - name: Configure Git Credentials | |
| run: | | |
| git config user.name github-actions[bot] | |
| git config user.email 41898282+github-actions[bot]@users.noreply.github.com | |
| - uses: actions/setup-python@v5 | |
| with: | |
| python-version: 3.x | |
| - run: echo "cache_id=$(date --utc '+%V')" >> $GITHUB_ENV | |
| - name: Install Doxygen | |
| run: sudo apt-get install -y doxygen | |
| - name: Setup conda environment | |
| uses: conda-incubator/setup-miniconda@v2 | |
| with: | |
| auto-update-conda: true | |
| python-version: 3.9.2 | |
| - name: Replace the changelog/index.md with the latest CHANGELOG.md but convert it to UTF8 | |
| run: iconv -f ISO-8859-1 -t UTF-8 CHANGELOG.md > docs/changelog/index.md | |
| - name: Replace the CONTRIBUTING_copy.md with the latest CONTRIBUTING.md but convert it to UTF8 | |
| run: iconv -f ISO-8859-1 -t UTF-8 CONTRIBUTING.md > docs/contributing/index.md | |
| - name: Create ac conda environment | |
| run: conda env create -f environment.yml | |
| - name: Build the documentation | |
| run: conda run -n ac mkdocs build | |
| # - name: Deploy to GitHub Pages | |
| # uses: peaceiris/actions-gh-pages@v3 | |
| # with: | |
| # github_token: ${{ secrets.GITHUB_TOKEN }} | |
| # publish_dir: ./site | |
| - run: conda run -n ac mkdocs gh-deploy --force | |
| # permissions: | |
| # contents: write | |
| # jobs: | |
| # deploy: | |
| # runs-on: ubuntu-latest | |
| # steps: | |
| # - uses: actions/checkout@v4 | |
| # - name: Configure Git Credentials | |
| # run: | | |
| # git config user.name github-actions[bot] | |
| # git config user.email 41898282+github-actions[bot]@users.noreply.github.com | |
| # - uses: actions/setup-python@v5 | |
| # with: | |
| # python-version: 3.x | |
| # - run: echo "cache_id=$(date --utc '+%V')" >> $GITHUB_ENV | |
| # - uses: actions/cache@v4 | |
| # with: | |
| # key: mkdocs-material-${{ env.cache_id }} | |
| # path: .cache | |
| # restore-keys: | | |
| # mkdocs-material- | |
| # - run: pip install mkdocs-material | |
| # - run: mkdocs gh-deploy --force |