Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

started to add Doxygen documentation #64

Merged
merged 3 commits into from
Nov 4, 2024
Merged

started to add Doxygen documentation #64

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
cc7e074
started to add Doxygen documentation
dietmarkuehl Nov 4, 2024
2283336
added gh-pages workflow
dietmarkuehl Nov 4, 2024
c1f018c
tweaking the documentation generation
dietmarkuehl Nov 4, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 18 additions & 0 deletions .github/workflows/doxygen-gh-pages.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
name: Doxygen GitHub Pages Deploy Action

on:
push:
branches:
- main

jobs:
deploy:
runs-on: ubuntu-latest
permissions:
contents: write
steps:
- uses: DenverCoder1/[email protected]
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
branch: gh-pages
folder: docs/html
4 changes: 2 additions & 2 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,9 +32,9 @@
*.app

build
mkerr
olderr
.DS_store
.vs
.vscode
stagedir
docs/html
docs/latex
5 changes: 4 additions & 1 deletion Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
# SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception

SANITIZERS = release debug msan asan usan tsan
.PHONY: default run update check ce todo distclean clean build test all format $(SANITIZERS)
.PHONY: default doc run update check ce todo distclean clean build test all format $(SANITIZERS)

COMPILER=system
CXX_BASE=$(CXX:$(dir $(CXX))%=%)
Expand Down Expand Up @@ -51,6 +51,9 @@ all: $(SANITIZERS)
run: test
./$(BUILD)/examples/$(EXAMPLE)

doc:
doxygen docs/Doxyfile

release: test

$(SANITIZERS):
Expand Down
Loading