mirror of
https://github.com/Next-Flip/Momentum-Firmware.git
synced 2026-04-24 03:29:57 -07:00
fbt: doxygen target (#3510)
* fbt: doxygen target * github: adjustments for doxygen * github: always generate docs, only upload for dev * doxygen: fixed exclusion path for awesome-css * github: stricter check for push ref * github: bumped action version to fix node.js deprecation * github: added PVS report url to workflow summary * github: pvs: reworked report URL handling * github: added size report to summary * docs: added `doxygen` target * fbt: common naming scheme for COMSTR * Documentation: fix warnings and errors * Doxygen: stricter warning checks * fbt: "doxy" target, opens generated doxygen documentation in browser * github: doxygen: now using edge (1.10) version Co-authored-by: あく <alleteam@gmail.com>
This commit is contained in:
8
.github/workflows/docs.yml
vendored
8
.github/workflows/docs.yml
vendored
@@ -4,6 +4,7 @@ on:
|
||||
push:
|
||||
branches:
|
||||
- dev
|
||||
pull_request:
|
||||
|
||||
env:
|
||||
TARGETS: f7
|
||||
@@ -37,12 +38,17 @@ jobs:
|
||||
python3 scripts/get_env.py "--event_file=${{ github.event_path }}" "--type=$TYPE"
|
||||
|
||||
- name: 'Generate documentation'
|
||||
uses: mattnotmitt/doxygen-action@v1.9.8
|
||||
uses: mattnotmitt/doxygen-action@edge
|
||||
env:
|
||||
DOXY_SRC_ROOT: "${{ github.workspace }}"
|
||||
DOXY_CONFIG_DIR: "${{ github.workspace }}/documentation/doxygen"
|
||||
DOXY_OUTPUT_DIR: "${{ github.workspace }}/documentation/doxygen/build"
|
||||
with:
|
||||
working-directory: 'documentation/'
|
||||
doxyfile-path: './doxygen/Doxyfile-awesome.cfg'
|
||||
|
||||
- name: 'Upload documentation'
|
||||
if: ${{ github.event_name == 'push' && github.ref == 'refs/heads/dev' }}
|
||||
uses: jakejarvis/s3-sync-action@v0.5.1
|
||||
env:
|
||||
AWS_S3_BUCKET: "${{ secrets.FW_DOCS_AWS_BUCKET }}"
|
||||
|
||||
Reference in New Issue
Block a user