Skip to content

Commit

Permalink
Merge branch 'firmware-doc' of https://github.com/pfe-rs/lk-s-2024-mi…
Browse files Browse the repository at this point in the history
…loje-api into firmware-doc
  • Loading branch information
Sugaravel committed Oct 6, 2024
2 parents 406967a + 2a410cd commit b60f82e
Show file tree
Hide file tree
Showing 4 changed files with 2,939 additions and 0 deletions.
45 changes: 45 additions & 0 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
name: Deploy to Pages
on:
push:
branches:
- master
- firmware-doc
- library-doc
workflow_dispatch:
# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
permissions:
contents: read
pages: write
id-token: write
# Allow one concurrent deployment
concurrency:
group: "pages"
cancel-in-progress: true
# Default to bash
defaults:
run:
shell: bash
jobs:
build:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v4
- name: Install Doxygen
run: sudo apt-get install doxygen graphviz fonts-freefont-ttf
- name: Run Doxygen
run: doxygen
- name: Upload artifact
uses: actions/upload-pages-artifact@v1
with:
path: ./docs
deploy:
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
runs-on: ubuntu-latest
needs: build
steps:
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v1
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,2 +1,4 @@
.venv
__pycache__
docs/firmware
docs/library
Loading

0 comments on commit b60f82e

Please sign in to comment.