Skip to content

Commit

Permalink
[doc] doxygen attach github pages (#9859)
Browse files Browse the repository at this point in the history
* [doc] doxygen attach github pages

* Update doxygen.yml

* Update doxygen.yml

* Update doxygen.yml

* Update doxygen.yml
  • Loading branch information
supperthomas authored Jan 3, 2025
1 parent 9291946 commit f76b97e
Showing 1 changed file with 38 additions and 3 deletions.
41 changes: 38 additions & 3 deletions .github/workflows/doxygen.yml
Original file line number Diff line number Diff line change
Expand Up @@ -11,28 +11,63 @@ on:
- 'components/dfs/dfs_v2/include/**'
- 'components/dfs/dfs_v2/src/**'
- 'components/finsh/**'
- '.github/workflows/doxygen.yml'
# Runs at 16:00 UTC (BeiJing 00:00) on the 30st of every month
push:
branches: [master]
paths:
- 'documentation/doxygen/**'
- 'src/**'
- 'include/**'
- 'components/drivers/include/drivers/**'
- 'components/dfs/dfs_v2/include/**'
- 'components/dfs/dfs_v2/src/**'
- 'components/finsh/**'
- '.github/workflows/doxygen.yml'
schedule:
- cron: '0 16 30 * *'
workflow_dispatch:


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

jobs:
build:
runs-on: ubuntu-22.04
name: doxygen_doc generate
if: github.repository_owner == 'RT-Thread'
steps:
- uses: actions/checkout@v4
- uses: actions/checkout@main
with:
submodules: 'recursive'
- name: Install Tools
shell: bash
run: |
sudo apt-get update
sudo apt-get -qq install doxygen graphviz
- name: generat doxygen html
- name: generate doxygen html
shell: bash
run: |
cd documentation/doxygen
doxygen Doxyfile
cat Doxyfile
- name: Upload static files as artifact
id: deployment
uses: actions/upload-pages-artifact@main # or specific "vX.X.X" version tag for this action
with:
path: documentation/doxygen/html/

deploy:
if: github.event_name == 'push'
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
runs-on: ubuntu-22.04
needs: build
steps:
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@main

0 comments on commit f76b97e

Please sign in to comment.