mirror of
https://github.com/zeldaret/tp
synced 2026-05-23 06:54:28 -04:00
Doxygen (#84)
* set up Doxygen - `.gitignore`: ignore Doxygen output - limit Doxygen search to relevant paths - move extra `.md`s to docs/ - `Makefile`: add Doxygen target - use as much SVG as possible for Doxygen diagrams - alias @meme as an \xrefitem * new github workflow: run doxygen and push to gh pages
This commit is contained in:
@@ -0,0 +1,23 @@
|
||||
name: run Doxygen to generate docs
|
||||
|
||||
on:
|
||||
push:
|
||||
branches:
|
||||
- main
|
||||
|
||||
jobs:
|
||||
build:
|
||||
runs-on: ubuntu-latest
|
||||
|
||||
steps:
|
||||
- uses: actions/checkout@v2
|
||||
- name: generate docs
|
||||
uses: mattnotmitt/doxygen-action@v1
|
||||
with:
|
||||
doxyfile-path: 'Doxyfile'
|
||||
enable-latex: true
|
||||
- name: deploy docs to github pages
|
||||
uses: peaceiris/actions-gh-pages@v3
|
||||
with:
|
||||
github_token: ${{ secrets.GITHUB_TOKEN }}
|
||||
publish_dir: ./docs/doxygen
|
||||
Reference in New Issue
Block a user