Skip to content

Commit

Permalink
Use the core utilities tagfile for linked docs.
Browse files Browse the repository at this point in the history
  • Loading branch information
LTLA committed Jul 8, 2024
1 parent a5f75b5 commit 773d3c4
Show file tree
Hide file tree
Showing 3 changed files with 13 additions and 2 deletions.
11 changes: 10 additions & 1 deletion .github/workflows/doxygenate.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -10,18 +10,27 @@ jobs:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4

- name: Add Pretty CSS
uses: wei/wget@v1
with:
args: -O docs/doxygen-awesome.css https://raw.githubusercontent.com/jothepro/doxygen-awesome-css/main/doxygen-awesome.css
- name: Download tagfile

- name: Download tatami tagfile
uses: wei/wget@v1
with:
args: -O docs/tatami.tag https://tatami-inc.github.io/tatami/tatami.tag

- name: Download core utilities tagfile
uses: wei/wget@v1
with:
args: -O docs/scran_core_utils.tag https://libscran.github.io/core_utils/scran_core_utils.tag

- name: Doxygen Action
uses: mattnotmitt/doxygen-action@v1
with:
working-directory: docs/

- name: GH Pages Deployment
uses: JamesIves/github-pages-deploy-action@v4
with:
Expand Down
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -3,3 +3,4 @@
build/
docs/html
docs/latex
docs/*.tag
3 changes: 2 additions & 1 deletion docs/Doxyfile
Original file line number Diff line number Diff line change
Expand Up @@ -2323,7 +2323,8 @@ SKIP_FUNCTION_MACROS = YES
# the path). If a tag file is not located in the directory in which doxygen is
# run, you must also specify the path to the tagfile here.

TAGFILES = tatami.tag=https://tatami-inc.github.io/tatami
TAGFILES = tatami.tag=https://tatami-inc.github.io/tatami \
scran_core_utils.tag=https://libscran.github.io/core_utils

# When a file name is specified after GENERATE_TAGFILE, doxygen will create a
# tag file that is based on the input files it reads. See section "Linking to
Expand Down

0 comments on commit 773d3c4

Please sign in to comment.