Skip to content

Commit 6c01efc

Browse files
committed
Add Doxygen configuration and documentation workflow
- Introduced a new Doxyfile for generating documentation for the cpp-core project, specifying project details and output settings. - Removed the outdated GitHub Actions workflow for building WASM binaries. - Added a new GitHub Actions workflow for generating and deploying Doxygen documentation to GitHub Pages, including steps for installation and documentation generation. These changes enhance project documentation and streamline the deployment process for generated docs.
1 parent f4cba5b commit 6c01efc

File tree

3 files changed

+94
-40
lines changed

3 files changed

+94
-40
lines changed

.github/workflows/build.yml

Lines changed: 0 additions & 40 deletions
This file was deleted.

.github/workflows/doxygen.yml

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
name: 'Generate & Deploy Doxygen Docs'
2+
3+
on:
4+
push:
5+
branches: [ main ]
6+
paths:
7+
- 'include/**'
8+
- 'Doxyfile'
9+
- '.github/workflows/doxygen.yml'
10+
workflow_dispatch:
11+
12+
# Required for GitHub Pages deployment
13+
permissions:
14+
contents: write # to push gh-pages for classic page
15+
pages: write # to deploy using actions/deploy-pages@v1
16+
id-token: write # to authenticate deployment
17+
18+
jobs:
19+
build-docs:
20+
runs-on: ubuntu-latest
21+
name: 'Build Doxygen HTML'
22+
steps:
23+
- name: Checkout
24+
uses: actions/checkout@v3
25+
26+
- name: Install Doxygen + Graphviz
27+
run: |
28+
sudo apt-get update -qq
29+
sudo apt-get install -y doxygen graphviz
30+
31+
- name: Generate documentation
32+
run: |
33+
doxygen -v
34+
doxygen Doxyfile
35+
36+
# Upload the generated site as an artifact for the deploy job
37+
- name: Upload Pages artifact
38+
uses: actions/upload-pages-artifact@v1
39+
with:
40+
path: docs/html
41+
42+
deploy:
43+
needs: build-docs
44+
runs-on: ubuntu-latest
45+
name: 'Deploy to GitHub Pages'
46+
steps:
47+
- name: Deploy
48+
id: deployment
49+
uses: actions/deploy-pages@v1

Doxyfile

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
#--------------------------------------------------------------------------
2+
# Doxyfile – generated for cpp-core
3+
#--------------------------------------------------------------------------
4+
5+
# Project related --------------------------------------------------------
6+
PROJECT_NAME = "cpp-core"
7+
PROJECT_BRIEF = "Header-only C++ helper library"
8+
PROJECT_NUMBER = "1.0"
9+
OUTPUT_DIRECTORY = docs/html
10+
CREATE_SUBDIRS = NO
11+
12+
# Build options ----------------------------------------------------------
13+
EXTRACT_ALL = YES
14+
EXTRACT_PRIVATE = YES
15+
EXTRACT_STATIC = YES
16+
EXTRACT_ANON_NSPACES = YES
17+
18+
# Source files -----------------------------------------------------------
19+
INPUT = include README.md LICENSE
20+
FILE_PATTERNS = *.h *.hpp *.md
21+
RECURSIVE = YES
22+
23+
# HTML output ------------------------------------------------------------
24+
GENERATE_HTML = YES
25+
HTML_OUTPUT = .
26+
HTML_COLORSTYLE_HUE = 220
27+
HTML_COLORSTYLE_SAT = 100
28+
HTML_COLORSTYLE_GAMMA = 80
29+
30+
# Disable unwanted output -----------------------------------------------
31+
GENERATE_LATEX = NO
32+
GENERATE_MAN = NO
33+
GENERATE_RTF = NO
34+
GENERATE_XML = NO
35+
36+
# Diagrams --------------------------------------------------------------
37+
HAVE_DOT = YES
38+
DOT_IMAGE_FORMAT = svg
39+
CALL_GRAPH = YES
40+
CALLER_GRAPH = YES
41+
42+
# Misc ------------------------------------------------------------------
43+
FULL_PATH_NAMES = NO
44+
STRIP_FROM_PATH = include
45+
GENERATE_TREEVIEW = YES

0 commit comments

Comments
 (0)