* 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:
Erin Moon
2021-01-18 13:00:28 -06:00
committed by GitHub
parent 7b97550cee
commit 8a7a0e502a
7 changed files with 2610 additions and 3 deletions
+23
View File
@@ -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