mirror of
https://github.com/Next-Flip/Momentum-Firmware.git
synced 2026-04-24 03:29:57 -07:00
ecab4d53d2
* Add doxygen and doxygen-awesome css, cleanup docs files * Ignore more libraries and remove leftover local variables * Create an actual intro page * .md files linting * Add doxygen action * Fix Doxygen path * Fix doxyfile path * Try to upload * Change docs branch * Add submudules checkout * Disable doxygen on PR * Mention the firmware docs in the readme * More dev docs mentions in the readme * Fix runner group, add tags * Test dev in PR * Disable running on PR * Fix a typo in the doxyfile * Try upload to S3 * Fix local path * Fix S3 ACL * Add delete flag, unifying dev and tags * Update ignored directories * More ignored directories * Even more ignored directories * Fix submodule * Change S3 uploader * Change S3 uploader version * Fix aws sync flags * Fix ACL * Disable ACL * Improve ignores, add WiFi devboard docs * TEMP: generate dev docs * TEMP: generate 0.89.0 docs * Disabling PR trigger * Enable submodules and test build * Enable test build * Disable test build * Change docs directory structure * Fix accidentally committed submodule * Fix submodules * Update links to the developer documentation * Markdown linting * Update workflow, enable test build * Fix doxygen dir path * Update Doxyfile-awesome.cfg * Change paths * Fix upload docs path * Disable pull_request debug trigger * Disable tags building * Remove autolinks and namespaces * Establish basic documentation structure * Add missing changes * Improve stylesheet, move some files * Improve examples * Improve the main page * Improve application dev docs * Improve system programming docs * Improve development tools docs * Improve other docs * Improve application examples * Fix formatting * Fix PVS-studio warnings * Improve visuals * Fix doxygen syntax warnings * Fix broken links * Update doxygen action Co-authored-by: DrunkBatya <drunkbatya.js@gmail.com> Co-authored-by: あく <alleteam@gmail.com> Co-authored-by: Georgii Surkov <georgii.surkov@outlook.com> Co-authored-by: Georgii Surkov <37121527+gsurkov@users.noreply.github.com>
57 lines
1.6 KiB
YAML
57 lines
1.6 KiB
YAML
name: 'Generate documentation with Doxygen'
|
|
|
|
on:
|
|
push:
|
|
branches:
|
|
- dev
|
|
|
|
env:
|
|
TARGETS: f7
|
|
DEFAULT_TARGET: f7
|
|
|
|
jobs:
|
|
doxygen:
|
|
if: ${{ !github.event.pull_request.head.repo.fork }}
|
|
runs-on: ubuntu-latest
|
|
steps:
|
|
- name: 'Wipe workspace'
|
|
run: find ./ -mount -maxdepth 1 -exec rm -rf {} \;
|
|
|
|
- name: 'Checkout code'
|
|
uses: actions/checkout@v4
|
|
with:
|
|
submodules: true
|
|
fetch-depth: 1
|
|
ref: ${{ github.event.pull_request.head.sha }}
|
|
|
|
- name: 'Get commit details'
|
|
id: names
|
|
run: |
|
|
if [[ ${{ github.event_name }} == 'pull_request' ]]; then
|
|
TYPE="pull"
|
|
elif [[ "${{ github.ref }}" == "refs/tags/"* ]]; then
|
|
TYPE="tag"
|
|
else
|
|
TYPE="other"
|
|
fi
|
|
python3 scripts/get_env.py "--event_file=${{ github.event_path }}" "--type=$TYPE"
|
|
|
|
- name: 'Generate documentation'
|
|
uses: mattnotmitt/doxygen-action@v1.9.8
|
|
with:
|
|
working-directory: 'documentation/'
|
|
doxyfile-path: './doxygen/Doxyfile-awesome.cfg'
|
|
|
|
- name: 'Upload documentation'
|
|
uses: jakejarvis/s3-sync-action@v0.5.1
|
|
env:
|
|
AWS_S3_BUCKET: "${{ secrets.FW_DOCS_AWS_BUCKET }}"
|
|
AWS_ACCESS_KEY_ID: "${{ secrets.FW_DOCS_AWS_ACCESS_KEY }}"
|
|
AWS_SECRET_ACCESS_KEY: "${{ secrets.FW_DOCS_AWS_SECRET_KEY }}"
|
|
AWS_REGION: "${{ secrets.FW_DOCS_AWS_REGION }}"
|
|
SOURCE_DIR: "./documentation/doxygen/build/html"
|
|
DEST_DIR: "${{steps.names.outputs.branch_name}}"
|
|
with:
|
|
args: "--delete"
|
|
|