Skip to content

Merge branch 'feature/new-docs' of https://github.com/forntoh/LcdMenu… #44

Merge branch 'feature/new-docs' of https://github.com/forntoh/LcdMenu…

Merge branch 'feature/new-docs' of https://github.com/forntoh/LcdMenu… #44

Workflow file for this run

name: Build and Deploy Docs
on:
push:
paths:
- "src/**"
- "docs/**"
- "examples/**"
- ".scripts/**"
- ".github/workflows/docs.yml"
permissions:
contents: write
pages: write
id-token: write
jobs:
build-docs:
runs-on: ubuntu-latest
steps:
- name: Checkout code
uses: actions/checkout@v4
- name: Set up Python
uses: actions/setup-python@v2
with:
python-version: "3.x"
- name: Install dependencies
run: |
python -m pip install --upgrade pip
pip install -r requirements.txt
sudo apt-get update
sudo apt-get install -y doxygen graphviz default-jre plantuml
- name: Generate Doxygen documentation
run: doxygen docs/Doxyfile
- name: Generate Sphinx documentation from Doxygen
run: python .scripts/link_doxygen_sphinx.py
- name: Link Examples
run: python .scripts/link_examples_sphinx.py
- name: Run changelog updater
run: python .scripts/update_changelog.py
- name: Append includes to index files
run: |
python .scripts/append_includes.py docs/source/reference/migration desc false
- name: Generate Sphinx documentation
run: make html
working-directory: docs
env:
GITHUB_ACTIONS: true
- name: Deploy documentation
uses: peaceiris/actions-gh-pages@v3
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: ./docs/_build/html