mirror of
https://github.com/TheLartians/ModernCppStarter.git
synced 2025-08-30 13:41:13 +02:00
Doxygen support (#43)
* init doxygen * fix format * use readme as main file * don't generate LaTeX * automatically use correct project version and update html settings * minify Doxyfile * add documentation * add workflow to publish documentation * remove mac comment * formatting * fix typo * grammar
This commit is contained in:
parent
fa77b5371f
commit
032e506c12
7 changed files with 144 additions and 13 deletions
27
.github/workflows/documentation.yaml
vendored
Normal file
27
.github/workflows/documentation.yaml
vendored
Normal file
|
@ -0,0 +1,27 @@
|
|||
name: Documentation
|
||||
|
||||
on:
|
||||
push:
|
||||
tags:
|
||||
- '*'
|
||||
|
||||
jobs:
|
||||
build:
|
||||
name: Build and publish documentation
|
||||
runs-on: macos-latest
|
||||
steps:
|
||||
- uses: actions/checkout@v1
|
||||
|
||||
- name: Install doxygen
|
||||
run: brew install doxygen
|
||||
|
||||
- name: Build
|
||||
run: |
|
||||
cmake -Hdocumentation -Bbuild
|
||||
cmake --build build --target GenerateDocs
|
||||
|
||||
- name: Publish
|
||||
uses: peaceiris/actions-gh-pages@v3
|
||||
with:
|
||||
github_token: ${{ secrets.GITHUB_TOKEN }}
|
||||
publish_dir: ./build/doxygen/html
|
Loading…
Add table
Add a link
Reference in a new issue