Merge pull request #90 from msricher/readme #45
This file contains hidden or 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_website | |
| on: | |
| push: | |
| branches: | |
| - master | |
| permissions: | |
| contents: write | |
| deployments: write | |
| pages: write | |
| jobs: | |
| build: | |
| runs-on: ubuntu-latest | |
| permissions: | |
| contents: write | |
| deployments: write | |
| pages: write | |
| steps: | |
| - name: Checkout repository | |
| uses: actions/checkout@v4 | |
| - name: Install dependencies | |
| run: | | |
| pip install --upgrade pip | |
| pip install pypandoc_binary | |
| pip install .[doc] | |
| - name: Setup pandoc | |
| uses: siacodelabs/setup-pandoc@v1 | |
| with: | |
| xelatex: true | |
| - name: Build documentation | |
| run: | | |
| sphinx-apidoc -o website/_autosummary atomdb -M -f | |
| - name: Create soft links | |
| run: | | |
| cd website | |
| ln -s ../docs/notebooks ./examples | |
| ln -s ../docs/notebooks/images ./examples/images | |
| ln -s ../docs/source ./api | |
| cd ../ | |
| - name: Install Requirements | |
| run: | | |
| python3 -m pip install -r website/requirements.txt | |
| - name: Build Jupyter Book | |
| run: | | |
| jupyter-book build ./website/ | |
| # Push the book's HTML to github-pages | |
| # inspired by https://github.com/orgs/community/discussions/26724 | |
| # only push to gh-pages if the master branch has been updated | |
| - name: GitHub Pages Action | |
| # if: ${{ github.event_name == 'push' && github.ref == 'refs/heads/master' }} | |
| uses: peaceiris/actions-gh-pages@v3 | |
| with: | |
| github_token: ${{ secrets.GITHUB_TOKEN }} | |
| publish_dir: ./website/_build/html | |
| publish_branch: gh-pages | |
| cname: atomdb.qcdevs.org |