Skip to content

Commit

Permalink
Add initial doxygen content
Browse files Browse the repository at this point in the history
  • Loading branch information
malcolm-sparkfun committed Dec 17, 2024
1 parent 8940aa0 commit e63ee8f
Show file tree
Hide file tree
Showing 42 changed files with 10,594 additions and 0 deletions.
65 changes: 65 additions & 0 deletions .github/workflows/build-deploy-ghpages.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,65 @@
name: Build Documentation and Deploy

on:
push:
branches:
- main
- documentation/doxygen
workflow_dispatch:

permissions:
contents: read
id-token: write
pages: write

concurrency:
group: "pages"
cancel-in-progress: true

jobs:
# Build job
build:
runs-on: ubuntu-latest
steps:
# Checkout the repository
- name: Checkout repository
uses: actions/checkout@v2
with:
fetch-depth: 0
submodules: "true"

- name: Set Version
run: echo "PROJECT_NUMBER = `git describe --tags`" >> ./docs/doxygen/doxygen-config

- name: Build Documentation
uses: mattnotmitt/[email protected]
with:
doxyfile-path: "./docs/doxygen/doxygen-config"

# Upload the documentation as an artifact
- name: Upload documentation
uses: actions/[email protected]
with:
path: ./docs/html

# Deploy job
deploy:
# Add a dependency to the build job
needs: build

# Grant GITHUB_TOKEN the permissions required to make a Pages deployment
permissions:
pages: write # to deploy to Pages
id-token: write # to verify the deployment originates from an appropriate source

# Deploy to the github-pages environment
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}

# Specify runner + deployment step
runs-on: ubuntu-latest
steps:
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4 # or specific "vX.X.X" version tag for this action
22 changes: 22 additions & 0 deletions docs/doxygen/doxygen-awesome-css/.github/workflows/publish.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
name: publish
on:
release:
types: [published]
jobs:
deploy:
runs-on: ubuntu-20.04
steps:
- name: Checkout repository
uses: actions/checkout@v2
with:
fetch-depth: 0
- name: set version
run: echo "PROJECT_NUMBER = `git describe --tags`" >> Doxyfile
- name: Generate Documentation
uses: mattnotmitt/doxygen-action@edge
- name: Publish generated content to GitHub Pages
uses: tsunematsu21/[email protected]
with:
dir: docs/html
branch: gh-pages
token: ${{ secrets.ACCESS_TOKEN }}
6 changes: 6 additions & 0 deletions docs/doxygen/doxygen-awesome-css/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
docs/html
.DS_Store
.idea

node_modules
*.tgz
3 changes: 3 additions & 0 deletions docs/doxygen/doxygen-awesome-css/.npmignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
*
!doxygen-awesome*

Loading

0 comments on commit e63ee8f

Please sign in to comment.