Skip to content

Commit

Permalink
First draft commit for automatic C++ documentation.
Browse files Browse the repository at this point in the history
  • Loading branch information
isazi committed May 2, 2024
1 parent 8722e25 commit ddf44a2
Show file tree
Hide file tree
Showing 12 changed files with 3,297 additions and 2 deletions.
48 changes: 48 additions & 0 deletions .github/workflows/documentation.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
# This is a basic workflow to help you get started with Actions
name: Build documentation

# Controls when the workflow will run
on:
# Triggers the workflow on push or pull request events but only for the master branch
push:
branches: [ main ]

# Allows you to run this workflow manually from the Actions tab
workflow_dispatch:

# A workflow run is made up of one or more jobs that can run sequentially or in parallel
jobs:
# This workflow contains a single job called "build"
build:
permissions:
id-token: write
pages: write
contents: write

# The type of runner that the job will run on
runs-on: ubuntu-latest

steps:
- name: Setup python
uses: actions/setup-python@v2
with:
python-version: '3.8'
- name: Checkout
uses: actions/checkout@v2
with:
fetch-depth: 0 # otherwise, you will failed to push refs to dest repo
- name: Setup dependencies
run: |
sudo apt-get update
sudo apt-get install python3-sphinx pandoc doxygen
python -m pip install --upgrade pip
python -m pip install sphinx_rtd_theme unidecode nbsphinx wheel breathe exhale
- name: Build and commit
uses: sphinx-notes/pages@v2
with:
documentation_path: './docs'
- name: Push documentation
uses: ad-m/github-push-action@master
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
branch: gh-pages
Loading

0 comments on commit ddf44a2

Please sign in to comment.