mirror of
https://github.com/RT-Thread/rt-thread.git
synced 2025-02-15 02:19:09 +08:00
40f3b6a569
* doxygen: adjust documentation directory structure - Rename documentation/doxygen to documentation/0.doxygen and cleanup some unused files. - Add/rename folders for each sub sections, such as 1.introduction/...... Each sub section will be created as a subpage. - Generate initial Doxyfile, this Doxyfile will be used to unify doxygen generated API documents and those markdown files under documentation folder. This patch just add the default Doxyfile generated by running "doxygen -g". It is used as baseline to add more features/configurations. - Rename documentation/README.md to documentation/INDEX.md, and use it as mainpage. - Move 0.doxygen/readme.md to documentation/README.md. * doxygen: update configurations These configurations are from old documentation/doxygen/Doxyfile. Try best to compatible exixting design. * doxygen: add run script Add a script to automatic some operations. Updated the README.md. --------- Signed-off-by: Chen Wang <unicorn_wang@outlook.com> Co-authored-by: Supper Thomas <78900636@qq.com>
74 lines
1.9 KiB
YAML
74 lines
1.9 KiB
YAML
name: doc_doxygen
|
|
on:
|
|
pull_request:
|
|
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'
|
|
# 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@main
|
|
with:
|
|
submodules: 'recursive'
|
|
- name: Install Tools
|
|
shell: bash
|
|
run: |
|
|
sudo apt-get update
|
|
sudo apt-get -qq install doxygen graphviz
|
|
- name: generate doxygen html
|
|
shell: bash
|
|
run: |
|
|
cd documentation
|
|
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/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
|