Skip to content

Commit

Permalink
docs: replace absolute paths by relative
Browse files Browse the repository at this point in the history
This way, Doxygen also works in GitHub actions
  • Loading branch information
HenkKalkwater committed Apr 27, 2024
1 parent fbe8f56 commit 3f9ec02
Show file tree
Hide file tree
Showing 3 changed files with 8 additions and 6 deletions.
4 changes: 3 additions & 1 deletion .github/workflows/doxygen.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -15,12 +15,14 @@ jobs:
steps:
- name: Checkout
uses: actions/checkout@v4
with:
submodules: true
- name: Configure pages
uses: actions/configure-pages@v3
- name: Install the doxyqml filter
run: pip install doxyqml
- name: Doxygen
uses: mattnotmitt/doxygen-action@v1.9.5
uses: mattnotmitt/doxygen-action@1.10.0
- name: Upload GitHub pages artifact
uses: "actions/upload-pages-artifact@v2"
with:
Expand Down
6 changes: 3 additions & 3 deletions Doxyfile
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ PROJECT_BRIEF = "QML Library for interacting with the Jellyfin multimed
# pixels and the maximum width should not exceed 200 pixels. Doxygen will copy
# the logo to the output directory.

PROJECT_LOGO = /home/chris/Programmeren/Sailfish/harbour-sailfin/sailfish/icons/86x86/harbour-sailfin.png
PROJECT_LOGO = sailfish/icons/86x86/harbour-sailfin.png

# With the PROJECT_ICON tag one can specify an icon that is included in the tabs
# when the HTML document is shown. Doxygen will copy the logo to the output
Expand All @@ -74,7 +74,7 @@ PROJECT_ICON =
# entered, it will be relative to the location where doxygen was started. If
# left blank the current directory will be used.

OUTPUT_DIRECTORY = /home/chris/Programmeren/Sailfish/harbour-sailfin/doxygen
OUTPUT_DIRECTORY = doxygen

# If the CREATE_SUBDIRS tag is set to YES then doxygen will create up to 4096
# sub-directories (in 2 levels) under the output directory of each output format
Expand Down Expand Up @@ -949,7 +949,7 @@ WARN_LOGFILE =
# spaces. See also FILE_PATTERNS and EXTENSION_MAPPING
# Note: If this tag is empty the current directory is searched.

INPUT = /home/chris/Programmeren/Sailfish/harbour-sailfin/core
INPUT = core

# This tag can be used to specify the character encoding of the source files
# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses
Expand Down
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,8 @@ This application can be found on [OpenRepos.net](https://openrepos.net/content/a
<img alt="Screenshot showing the library root" src="graphics/screenshot-sailfish-1.png" width="33%" /> <img alt="Screenshot showing TV show page" src="graphics/screenshot-sailfish-2.png" width="33%" />

## Contributing
Please [see this page for contribution guidelines](https://sailfin.github.io/harbour-sailfin/contributing.html).
and [this page for how the Jellyfin-Qt library works](https://sailfin.github.io/harbour-sailfin/contributing.html).
Please [see this page for contribution guidelines](https://heartfin.github.io/harbour-sailfin/contributing.html).
and [this page for how the Jellyfin-Qt library works](https://heartfin.github.io/harbour-sailfin/contributing.html).

## Code layout
```
Expand Down

0 comments on commit 3f9ec02

Please sign in to comment.