-
-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: Add Doxygen and project-related documentation
- Loading branch information
1 parent
c5541b0
commit 720a1ed
Showing
14 changed files
with
3,186 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,40 @@ | ||
name: doxygen | ||
run-name: Generate and deploy Doxygen documentation | ||
on: | ||
push: | ||
branches: | ||
- "master" | ||
workflow_dispatch: {} | ||
permissions: | ||
contents: read | ||
pages: write | ||
id-token: write | ||
jobs: | ||
build: | ||
runs-on: ubuntu-latest | ||
steps: | ||
- name: Checkout | ||
uses: actions/checkout@v4 | ||
uses: actions/configure-pages@v3 | ||
- uses: actions/setup-python@v5 | ||
with: | ||
python-version: '3.9' | ||
cache: 'pip' # caching pip dependencies | ||
- run: pip install doxyqml | ||
- name: Doxygen | ||
uses: uses: mattnotmitt/[email protected] | ||
- name: Upload GitHub pages artifact | ||
uses: "actions/upload-pages-artifact@v2" | ||
with: | ||
path: "doxygen/html/" | ||
|
||
deploy: | ||
runs-on: ubuntu-latest | ||
needs: build | ||
environment: | ||
name: github-pages | ||
url: ${{ steps.deployment.outputs.page_url }} | ||
steps: | ||
- name: Deploy to GitHub Pages | ||
id: deployment | ||
uses: "actions/deploy-pages@v2" |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -5,6 +5,7 @@ rpm/*.spec | |
build/ | ||
build-*/ | ||
.dub/ | ||
doxygen/ | ||
|
||
# IDE files | ||
*.user | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
[submodule "core/doc/doxygen-awesome-css"] | ||
path = core/doc/doxygen-awesome-css | ||
url = https://github.com/jothepro/doxygen-awesome-css.git | ||
[submodule "3rdparty/doxygen-awesome-css"] | ||
path = 3rdparty/doxygen-awesome-css | ||
url = https://github.com/jothepro/doxygen-awesome-css.git |
Submodule doxygen-awesome-css
added at
5b27b3
Oops, something went wrong.