From 5252c23f75022cd0763c2aabf6d85333e0da95cb Mon Sep 17 00:00:00 2001 From: legohead259 Date: Wed, 28 Feb 2024 13:56:06 -0500 Subject: [PATCH] Added docs --- .github/ISSUE_TEMPLATE/workflows/sphinx.yaml | 37 ++++++++++++++++++++ 1 file changed, 37 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/workflows/sphinx.yaml diff --git a/.github/ISSUE_TEMPLATE/workflows/sphinx.yaml b/.github/ISSUE_TEMPLATE/workflows/sphinx.yaml new file mode 100644 index 0000000..377871a --- /dev/null +++ b/.github/ISSUE_TEMPLATE/workflows/sphinx.yaml @@ -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 \ No newline at end of file