updated usage guide #13
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: Sphinx build | |
| on: push | |
| jobs: | |
| sphinx-build: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - name: Build HTML | |
| with: | |
| pre-build-command: "apt install -y pandoc build-essential && python3 -m pip install -U sphinx sphinx-book-theme sphinx-copybutton sphinx-autobuild sphinxcontrib-mermaid sphinxcontrib-contentui nbsphinx sphinxcontrib-napoleon ipython jupyter numpy matplotlib scipy netcdf4 scikit-learn tornado future pandas ipympl cmdstanpy ipyfilechooser voila arviz cartopy pmagpy meson clang && sphinx-apidoc -f -o docs src/BiCEP/ && python3 -m build && python3 -m pip install -U ./" | |
| uses: ammaraskar/sphinx-action@0.4 | |
| - name: Upload artifacts | |
| uses: actions/upload-artifact@v4 | |
| with: | |
| name: html-docs | |
| path: docs/_build/html/ | |
| - name: Deploy | |
| uses: peaceiris/actions-gh-pages@v4 | |
| if: github.ref == 'refs/heads/beta' | |
| with: | |
| github_token: ${{ secrets.GITHUB_TOKEN }} | |
| publish_dir: docs/_build/html |