Skip to content

update README

update README #467

Workflow file for this run

name: Documentation
on:
push:
branches: [ "main" ]
jobs:
docs:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: actions/setup-python@v2
- name: Install dependencies
run: |
pip install setuptools sphinx breathe sphinx-sitemap sphinx-rtd-theme sphinx-copybutton sphinx-mermaid sphinxcontrib-bibtex
sudo apt-get install doxygen
- name: Sphinx build
run: |
sphinx-build docs _build
- name: Deploy
uses: peaceiris/actions-gh-pages@v3
with:
publish_branch: gh-pages
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: _build/
force_orphan: true