Merge pull request #84 from rahil-makadia/dev #465
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: Build docs | |
on: | |
push: | |
branches: | |
- main | |
- dev | |
paths: | |
- '.github/workflows/docs.yml' | |
- 'docs/**' | |
- 'include/**' | |
- 'src/**' | |
- 'grss/**' | |
jobs: | |
sphinx: | |
runs-on: ubuntu-latest | |
steps: | |
- name: Checkout repo | |
uses: actions/checkout@v4 | |
- name: Set up Python | |
uses: actions/setup-python@v5 | |
with: | |
python-version: 3.11 | |
- name: Install GRSS (including dependencies) | |
run: | | |
python3 -m pip install --upgrade pip | |
sudo apt-get install pandoc doxygen | |
pip3 install "pybind11[global]>=2.10.0" | |
cd extern | |
python3 get_cspice.py | |
cd .. | |
pip3 install . | |
- name: Build docs | |
run: | | |
python3 -m pip install sphinx-book-theme==1.0.1 pydata-sphinx-theme==0.15.2 | |
python3 -m pip install ipython sphinx sphinx-copybutton sphinx-gallery nbsphinx sphinx-favicon breathe | |
source build_cpp.sh -docs | |
cp build/libgrss* grss/ | |
cd docs | |
make clean html | |
cd .. | |
- name: Deploy | |
uses: peaceiris/actions-gh-pages@v4 | |
with: | |
publish_branch: gh-pages | |
github_token: ${{ secrets.GITHUB_TOKEN }} | |
publish_dir: docs/build/html |