Skip to content

Commit

Permalink
docs: Add Doxygen and project-related documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
HenkKalkwater committed Apr 27, 2024
1 parent c5541b0 commit 720a1ed
Show file tree
Hide file tree
Showing 14 changed files with 3,186 additions and 1 deletion.
40 changes: 40 additions & 0 deletions .github/workflows/doxygen.yaml
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"
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ rpm/*.spec
build/
build-*/
.dub/
doxygen/

# IDE files
*.user
Expand Down
6 changes: 6 additions & 0 deletions .gitmodules
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
1 change: 1 addition & 0 deletions 3rdparty/doxygen-awesome-css
Submodule doxygen-awesome-css added at 5b27b3
Loading

0 comments on commit 720a1ed

Please sign in to comment.