Skip to content

Commit

Permalink
feat: update doxygen
Browse files Browse the repository at this point in the history
* Add Modern Theme
* Update Deployment
* Remove pre-built doxygen files
  • Loading branch information
Curve committed Dec 6, 2023
1 parent 144ef0b commit 32531e3
Show file tree
Hide file tree
Showing 661 changed files with 155 additions and 80,529 deletions.
40 changes: 40 additions & 0 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
on:
push:
workflow_dispatch:

permissions:
contents: read
pages: write
id-token: write

name: 📄 Setup Documentation

jobs:
deploy:
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
runs-on: ubuntu-latest

steps:
- name: 📥 Checkout
uses: actions/checkout@v3

- name: 📋 Install Dependencies
run: sudo apt-get install doxygen

- name: 🔨 Build
run: |
doxygen docs/Doxyfile
- name: 🚀 Upload Artifact
uses: actions/upload-pages-artifact@v1
with:
path: html

- name: 📃 Setup Pages
uses: actions/configure-pages@v3

- name: 📦 Deploy
id: deployment
uses: actions/deploy-pages@v2
3 changes: 3 additions & 0 deletions .gitmodules
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
[submodule "docs/doxygen-awesome-css"]
path = docs/doxygen-awesome-css
url = https://github.com/jothepro/doxygen-awesome-css.git
File renamed without changes
24 changes: 24 additions & 0 deletions docs/Doxyfile
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
GENERATE_TREEVIEW = YES
DISABLE_INDEX = NO
FULL_SIDEBAR = NO
HTML_EXTRA_STYLESHEET = docs/doxygen-awesome-css/doxygen-awesome.css docs/doxygen-awesome-css/doxygen-awesome-sidebar-only-darkmode-toggle.css
HTML_EXTRA_FILES = docs/doxygen-awesome-css/doxygen-awesome-darkmode-toggle.js
HTML_COLORSTYLE = LIGHT
HTML_HEADER = docs/header.html

PROJECT_NAME = ViennaLS
ALWAYS_DETAILED_SEC = YES
INLINE_INHERITED_MEMB = YES
MULTILINE_CPP_IS_BRIEF = YES
EXTRACT_ALL = YES
EXTRACT_PACKAGE = YES
EXTRACT_STATIC = YES
EXTRACT_LOCAL_CLASSES = NO
GENERATE_TODOLIST = NO

RECURSIVE = YES
EXAMPLE_RECURSIVE = YES
EXCLUDE_PATTERNS = */build/* */docs/* */Python/* */cmake/* */doxygen-awesome-css/*

USE_MDFILE_AS_MAINPAGE = README.md
PROJECT_LOGO = assets/logo.png
7 changes: 0 additions & 7 deletions docs/Software Design/General.txt

This file was deleted.

138 changes: 0 additions & 138 deletions docs/Software Design/sharedObjectBuilding.graphml

This file was deleted.

Binary file removed docs/Software Design/sharedObjectBuilding.pdf
Binary file not shown.
1 change: 1 addition & 0 deletions docs/doxygen-awesome-css
Submodule doxygen-awesome-css added at df88fe
Loading

0 comments on commit 32531e3

Please sign in to comment.