Skip to content

Commit

Permalink
Merge branch 'feature/doxygen' into develop
Browse files Browse the repository at this point in the history
  • Loading branch information
Young Geun Kim committed Dec 16, 2024
2 parents 0ce288c + 4674528 commit 3877950
Show file tree
Hide file tree
Showing 9 changed files with 3,111 additions and 1 deletion.
3 changes: 2 additions & 1 deletion .Rbuildignore
Original file line number Diff line number Diff line change
Expand Up @@ -15,4 +15,5 @@
^cran-comments\.md$
^CRAN-SUBMISSION$
^revdep$
^python$
^python$
inst/doxygen
42 changes: 42 additions & 0 deletions .github/workflows/doxygen.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
# Render doxygen to github page repo
on:
push:
branches: [main, master, develop]
pull_request:
branches: [main, master]
workflow_dispatch:

name: doxygen

jobs:
doxygen:
runs-on: ubuntu-latest
# Only restrict concurrency for non-PR jobs
concurrency:
group: pkgdown-${{ github.event_name != 'pull_request' || github.run_id }}
env:
GITHUB_PAT: ${{ secrets.GITHUB_TOKEN }}
permissions:
contents: write
steps:
- uses: actions/checkout@v4

- name: Install Doxygen
run: sudo apt-get install -y doxygen graphviz

- name: Render doxygen
run: doxygen inst/doxygen/Doxyfile

- name: Create .nojekyll
run: sudo touch inst/doxygen/html/.nojekyll

- name: Deploy to GitHub pages 🚀
if: github.event_name != 'pull_request'
uses: JamesIves/github-pages-deploy-action@v4.6.1
with:
token: ${{ secrets.YGEUNKIM_PAGE_PAT }}
repository-name: ygeunkim/ygeunkim.github.io
clean: false
branch: master
folder: inst/doxygen/html
target-folder: package/bvhar/cpp
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -49,3 +49,5 @@ Meta
/src/*.so

^_pkgdown.yml

inst/doxygen/html/
2 changes: 2 additions & 0 deletions _pkgdown.yml
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,8 @@ home:
# see the configuration in .github/workflows/pkgdown.yaml
- text: VERSION_TEXT
href: VERSION_REF
- text: C++ headers
href: https://ygeunkim.github.io/package/bvhar/cpp/
- text: bvhar for Python
href: https://ygeunkim.github.io/package/bvhar/python/

Expand Down
Loading

0 comments on commit 3877950

Please sign in to comment.