Skip to content

add meshing and installation guides #3

add meshing and installation guides

add meshing and installation guides #3

Workflow file for this run

name: BiRD-documentation
on:
push:
branches: [ sphinx ]
paths:
- 'docs/**'
- '.github/workflows/docs_pages.yml'
jobs:
build_docs:
runs-on: ubuntu-latest
env:
GITHUB_PAT: ${{ secrets.GITHUB_TOKEN }}
steps:
- name: Checkout
uses: actions/checkout@v4
- name: Set up Python
uses: actions/setup-python@v5
with:
python-version: '3.10'
cache: 'pip'
- name: Install dependencies
run: |
python -m pip install --upgrade pip
pip install sphinx sphinx_rtd_theme sphinx-autoapi
- name: Build documentation
run: |
cd docs
make html
- name: deploy
uses: peaceiris/actions-gh-pages@v4
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: ./docs/_build/html
force_orphan: true
full_commit_message: ${{ github.event.head_commit.message }}