Skip to content

Commit

Permalink
Added docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Legohead259 committed Mar 5, 2024
1 parent be69317 commit 5252c23
Showing 1 changed file with 37 additions and 0 deletions.
37 changes: 37 additions & 0 deletions .github/ISSUE_TEMPLATE/workflows/sphinx.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
name: documentation

on:
push:
branches: [docs]
pull_request:
branches: [docs]
workflow_dispatch:

permissions:
contents: write

jobs:
docs:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: actions/setup-python@v5
with:
python-version: '3.10'
- name: Install dependencies
run: |
sudo apt-get install -y doxygen
pip install sphinx sphinx_rtd_theme myst_parser breathe
- name: Doxygen build
run: |
doxygen docs/Doxyfile
- name: Sphinx build
run: |
sphinx-build docs/source docs/build
- name: Deploy to GitHub Pages
uses: peaceiris/actions-gh-pages@v3
with:
publish_branch: gh-pages
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: docs/build
force_orphan: true

0 comments on commit 5252c23

Please sign in to comment.