site: feature Figures 1, 10, 11 in a Highlights showcase at the top #44
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: docs | |
| on: | |
| push: | |
| branches: [ v0.6 ] | |
| paths: | |
| - "docs/**" | |
| - "vortex_torch/**" | |
| - "assets/**" | |
| - ".github/workflows/docs.yaml" | |
| jobs: | |
| build-deploy: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - uses: actions/setup-python@v5 | |
| with: | |
| python-version: "3.12" | |
| - name: Install deps | |
| run: | | |
| python -m pip install -U sphinx myst-parser furo sphinx-autobuild sphinx-copybutton | |
| - name: Build docs | |
| run: | | |
| make -C docs html | |
| - name: Assemble site (landing page at root, Sphinx docs under /docs) | |
| run: | | |
| rm -rf public | |
| mkdir -p public/docs public/assets | |
| # Sphinx HTML -> /docs | |
| cp -r docs/_build/html/. public/docs/ | |
| # Welcome / landing page -> root | |
| cp docs/landing/index.html public/index.html | |
| # Assets referenced by the landing page (logo + paper figures) | |
| cp assets/vortex_mark.png assets/vortex_mark.svg \ | |
| assets/vortex_logo_flat.png assets/vortex_logo.svg \ | |
| assets/fig1_workflow.png assets/fig1_results.png \ | |
| assets/fig10_inno_a.png assets/fig10_inno_b.png assets/fig10_inno_c.png \ | |
| assets/fig11_iter_a.png assets/fig11_iter_b.png assets/fig11_iter_c.png \ | |
| assets/fig12_glm_a.png assets/fig16_mm_a.png \ | |
| public/assets/ || true | |
| - name: Deploy to GitHub Pages | |
| uses: peaceiris/actions-gh-pages@v3 | |
| with: | |
| github_token: ${{ secrets.GITHUB_TOKEN }} | |
| publish_dir: public |