Skip to content

Commit

Permalink
Autogenerated: Convert comments to doxygen and add doxygen configs
Browse files Browse the repository at this point in the history
  • Loading branch information
malcolm-sparkfun committed Jan 13, 2025
1 parent fa043d3 commit 2a4c828
Show file tree
Hide file tree
Showing 160 changed files with 10,654 additions and 23,332 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
- refactor/gpio_lists
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/doxygen-action@v1.9.5
with:
doxyfile-path: "./docs/doxygen/doxygen-config"

# Upload the documentation as an artifact
- name: Upload documentation
uses: actions/upload-pages-artifact@v3.0.1
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
4 changes: 0 additions & 4 deletions docs/_build/html/.buildinfo

This file was deleted.

Binary file removed docs/_build/html/.doctrees/apiref.doctree
Binary file not shown.
Binary file removed docs/_build/html/.doctrees/environment.pickle
Binary file not shown.
Binary file removed docs/_build/html/.doctrees/ex1.doctree
Binary file not shown.
Binary file removed docs/_build/html/.doctrees/ex2.doctree
Binary file not shown.
Binary file removed docs/_build/html/.doctrees/ex3.doctree
Binary file not shown.
Binary file removed docs/_build/html/.doctrees/ex4.doctree
Binary file not shown.
Binary file removed docs/_build/html/.doctrees/index.doctree
Binary file not shown.
217 changes: 0 additions & 217 deletions docs/_build/html/_modules/index.html

This file was deleted.

Loading

0 comments on commit 2a4c828

Please sign in to comment.