Skip to content

Commit

Permalink
Add workflow to generate and upload doxygen documentation (#463)
Browse files Browse the repository at this point in the history
* Added workflow to generate and upload doxygen documentation

This is for reviewing and debugging purposes, to simplify inspecting the call graph in a visual manner.
The generated doxygen documentation can be download from the actions tab as an artifact.

Co-authored-by: jsnel <[email protected]>Who provided the base version of the Doxyfile

* Renamed Doxyfile to Doxyfile.ini, so we get syntax highlighting
  • Loading branch information
s-weigand authored Nov 29, 2020
1 parent b73e3b4 commit 51b8799
Show file tree
Hide file tree
Showing 2 changed files with 2,635 additions and 0 deletions.
23 changes: 23 additions & 0 deletions .github/workflows/doxygen.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
name: "Doxygen"

on: [push, pull_request, workflow_dispatch]

jobs:
run-doxygen:
name: Doxygen callgraph
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- name: Set up Python 3.8
uses: actions/setup-python@v2
with:
python-version: 3.8
- name: Create Doxygen Docs
uses: mattnotmitt/doxygen-action@v1
with:
doxyfile-path: "docs/Doxyfile.ini"
- name: Upload Doxygen Docs Artifact
uses: actions/upload-artifact@v2
with:
name: doxygen_docs_pyglotaran
path: doxygen_docs_pyglotaran
Loading

0 comments on commit 51b8799

Please sign in to comment.