Skip to content

Commit ca7b82d

Browse files
committed
MAKE DOCS IN YML
1 parent a6055b4 commit ca7b82d

File tree

3 files changed

+18
-7
lines changed

3 files changed

+18
-7
lines changed

.github/workflows/doxygen.yml

Lines changed: 14 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,8 +16,20 @@ jobs:
1616
- name: Checkout code
1717
uses: actions/checkout@v3
1818

19-
- name: Install Doxygen
20-
run: sudo apt-get install -y doxygen
19+
- name: Install Dependencies
20+
run: |
21+
sudo apt-get update
22+
sudo apt-get install -y wget
23+
24+
- name: Install Latest Doxygen
25+
run: |
26+
wget -O doxygen.tar.gz https://doxygen.nl/files/doxygen-1.9.8.linux.bin.tar.gz
27+
tar -xzf doxygen.tar.gz
28+
sudo mv doxygen-1.9.8/bin/* /usr/local/bin/
29+
doxygen --version
30+
31+
- name: Create Output Directory
32+
run: mkdir -p docs/doxygen
2133

2234
- name: Generate Documentation
2335
run: doxygen Doxyfile

.gitignore

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,8 +17,7 @@ cmake_install.cmake
1717
Makefile
1818

1919
# Doxygen Output
20-
docs/doxygen/html/*
21-
docs/doxygen/latex/*
20+
docs/
2221
# Generated binaries and object files
2322
*.obj
2423
*.o

Doxyfile

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -348,7 +348,7 @@ OPTIMIZE_OUTPUT_SLICE = NO
348348
#
349349
# Note see also the list of default file extension mappings.
350350

351-
EXTENSION_MAPPING = md=markdown
351+
EXTENSION_MAPPING = md=markdown
352352

353353
# If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments
354354
# according to the Markdown format, which allows for more readable
@@ -358,7 +358,7 @@ EXTENSION_MAPPING = md=markdown
358358
# case of backward compatibilities issues.
359359
# The default value is: YES.
360360

361-
MARKDOWN_SUPPORT = YES
361+
MARKDOWN_SUPPORT = YES
362362

363363
# When the TOC_INCLUDE_HEADINGS tag is set to a non-zero value, all headings up
364364
# to that level are automatically included in the table of contents, even if
@@ -635,7 +635,7 @@ INTERNAL_DOCS = NO
635635
# Possible values are: SYSTEM, NO and YES.
636636
# The default value is: SYSTEM.
637637

638-
CASE_SENSE_NAMES = SYSTEM
638+
CASE_SENSE_NAMES = YES
639639

640640
# If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with
641641
# their full class and namespace scopes in the documentation. If set to YES, the

0 commit comments

Comments
 (0)