chris/harbour-sailfin
chris/harbour-sailfin
1
0
Fork 0
mirror of https://github.com/HenkKalkwater/harbour-sailfin.git synced 2024-12-22 14:05:18 +00:00
Code Issues Releases Wiki Activity

docs: replace absolute paths by relative

Browse source 
This way, Doxygen also works in GitHub actions
This commit is contained in:
Chris Josten 2024-04-27 23:25:14 +02:00
parent fbe8f5631c
commit 19efba457c
3 changed files with 8 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
.github/workflows/doxygen.yaml vendored
View file

@ -15,12 +15,14 @@ jobs:
steps: steps:
- name: Checkout - name: Checkout
uses: actions/checkout@v4 uses: actions/checkout@v4
with:
submodules: true
- name: Configure pages - name: Configure pages
uses: actions/configure-pages@v3 uses: actions/configure-pages@v3
- name: Install the doxyqml filter - name: Install the doxyqml filter
run: pip install doxyqml run: pip install doxyqml
- name: Doxygen - name: Doxygen
uses: mattnotmitt/doxygen-action@v1.9.5 uses: mattnotmitt/doxygen-action@edge
- name: Upload GitHub pages artifact - name: Upload GitHub pages artifact
uses: "actions/upload-pages-artifact@v2" uses: "actions/upload-pages-artifact@v2"
with: with:

6
Doxyfile
View file

@ -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 # pixels and the maximum width should not exceed 200 pixels. Doxygen will copy
# the logo to the output directory. # 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 # 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 # when the HTML document is shown. Doxygen will copy the logo to the output
@ -74,7 +74,7 @@ PROJECT_ICON =
# entered, it will be relative to the location where doxygen was started. If # entered, it will be relative to the location where doxygen was started. If
# left blank the current directory will be used. # 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 # 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 # sub-directories (in 2 levels) under the output directory of each output format
@ -949,7 +949,7 @@ WARN_LOGFILE =
# spaces. See also FILE_PATTERNS and EXTENSION_MAPPING # spaces. See also FILE_PATTERNS and EXTENSION_MAPPING
# Note: If this tag is empty the current directory is searched. # 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 # 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 # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses

4
README.md
View file

@ -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%" /> <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 ## Contributing
Please [see this page for contribution guidelines](https://sailfin.github.io/harbour-sailfin/contributing.html). Please [see this page for how the Jellyfin Qt library works](https://heartfin.github.io/harbour-sailfin/guides.html).
and [this page for how the Jellyfin-Qt library works](https://sailfin.github.io/harbour-sailfin/contributing.html). and [see this page for contribution guidelines](https://heartfin.github.io/harbour-sailfin/contributing.html).
## Code layout ## Code layout
``` ```