Doxygen-based documentation for C++ API (#796)
This commit is contained in:
25
.github/workflows/gh-pages-cpp-api.yml
vendored
Normal file
25
.github/workflows/gh-pages-cpp-api.yml
vendored
Normal file
@@ -0,0 +1,25 @@
|
||||
name: gh-pages-cpp-api
|
||||
|
||||
on:
|
||||
workflow_dispatch:
|
||||
|
||||
jobs:
|
||||
generate-and-deploy-gh-pages-cpp-api:
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- name: Checkout 🛎️
|
||||
uses: actions/checkout@v3
|
||||
|
||||
- name: Install Doxygen
|
||||
run: sudo apt-get install doxygen -y
|
||||
|
||||
- name: Generate documentation
|
||||
working-directory: docs/doxygen
|
||||
run: doxygen
|
||||
|
||||
- name: Deploy 🚀
|
||||
uses: JamesIves/github-pages-deploy-action@v4.4.1
|
||||
with:
|
||||
branch: gh-pages
|
||||
folder: docs/doxygen/html
|
||||
target-folder: cpp/api/
|
||||
@@ -1,13 +1,12 @@
|
||||
name: Build documentation
|
||||
name: Build & Deploy mdBook documentation
|
||||
|
||||
on:
|
||||
workflow_dispatch:
|
||||
|
||||
|
||||
jobs:
|
||||
build-docs:
|
||||
name: Build
|
||||
runs-on: ubuntu-20.04
|
||||
runs-on: ubuntu-22.04
|
||||
steps:
|
||||
- uses: actions/checkout@v2
|
||||
- uses: extractions/setup-just@v1
|
||||
@@ -17,17 +16,18 @@ jobs:
|
||||
shell: bash
|
||||
run: sudo apt-get install -y libwayland-dev libxkbcommon-dev # Required for winit
|
||||
- name: Build
|
||||
working-directory: docs
|
||||
working-directory: docs/mdbook
|
||||
shell: bash
|
||||
run: mdbook build
|
||||
- uses: actions/upload-artifact@v2
|
||||
with:
|
||||
name: book
|
||||
path: docs/book/
|
||||
path: docs/mdbook/book/
|
||||
|
||||
deploy-docs:
|
||||
needs: build-docs
|
||||
name: Deploy
|
||||
runs-on: ubuntu-20.04
|
||||
runs-on: ubuntu-22.04
|
||||
steps:
|
||||
- uses: actions/checkout@v2
|
||||
- name: Download book
|
||||
@@ -40,4 +40,4 @@ jobs:
|
||||
with:
|
||||
branch: gh-pages
|
||||
folder: artifacts
|
||||
target-folder: docs
|
||||
target-folder: docs/mdbook
|
||||
Reference in New Issue
Block a user