Skip to content

Commit cb5c961

Browse files
Fix theme issues
1 parent a46b932 commit cb5c961

File tree

5 files changed

+65
-43
lines changed

5 files changed

+65
-43
lines changed

.github/workflows/doxygen.yml

+4-2
Original file line numberDiff line numberDiff line change
@@ -8,14 +8,16 @@ on:
88
- "include/**"
99
- "Doxyfile"
1010
- "**/*.md"
11-
11+
- ".github/workflows/doxygen.yml"
1212
jobs:
1313
build-and-deploy:
1414
runs-on: ubuntu-latest
1515

1616
steps:
1717
- name: Checkout code
1818
uses: actions/checkout@v4
19+
with:
20+
submodules: recursive
1921

2022
- name: Set up Doxygen
2123
run: |
@@ -26,6 +28,6 @@ jobs:
2628
run: doxygen ./Doxyfile
2729

2830
- name: Deploying to Gh-pages
29-
uses: jinxto/doxygen-env-setup@v1
31+
uses: jinxto/doxygen-env-setup@v1.5
3032
with:
3133
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.gitmodules

+4
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
[submodule "doxygen-awesome-css"]
2+
path = doxygen-awesome-css
3+
url = https://github.com/Jinxto/doxygen-theme.git
4+
branch = main

Doxyfile

+55-40
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,26 @@
11
DOXYFILE_ENCODING = UTF-8
22
PROJECT_NAME = "mcpp"
33
PROJECT_NUMBER =
4-
PROJECT_BRIEF = "mcpp is a library that lets you interact with Minecraft using C++"
4+
PROJECT_BRIEF = "C++ Minecraft Library"
55
PROJECT_LOGO =
66
OUTPUT_DIRECTORY = ./doc/
77
CREATE_SUBDIRS = NO
8+
CREATE_SUBDIRS_LEVEL = 8
89
ALLOW_UNICODE_NAMES = NO
910
OUTPUT_LANGUAGE = English
10-
OUTPUT_TEXT_DIRECTION = None
1111
BRIEF_MEMBER_DESC = YES
1212
REPEAT_BRIEF = YES
1313
ABBREVIATE_BRIEF = "The $name class" \
1414
"The $name widget" \
1515
"The $name file" \
16-
is \
17-
provides \
18-
specifies \
19-
contains \
20-
represents \
21-
a \
22-
an \
23-
the
16+
is \
17+
provides \
18+
specifies \
19+
contains \
20+
represents \
21+
a \
22+
an \
23+
the
2424
ALWAYS_DETAILED_SEC = NO
2525
INLINE_INHERITED_MEMB = NO
2626
FULL_PATH_NAMES = YES
@@ -71,9 +71,10 @@ HIDE_UNDOC_CLASSES = NO
7171
HIDE_FRIEND_COMPOUNDS = NO
7272
HIDE_IN_BODY_DOCS = NO
7373
INTERNAL_DOCS = NO
74-
CASE_SENSE_NAMES = YES
74+
CASE_SENSE_NAMES = NO
7575
HIDE_SCOPE_NAMES = NO
76-
HIDE_COMPOUND_REFERENCE= NO
76+
HIDE_COMPOUND_REFERENCE = NO
77+
SHOW_HEADERFILE = YES
7778
SHOW_INCLUDE_FILES = YES
7879
SHOW_GROUPED_MEMB_INC = NO
7980
FORCE_LOCAL_INCLUDES = NO
@@ -87,7 +88,7 @@ STRICT_PROTO_MATCHING = NO
8788
GENERATE_TODOLIST = YES
8889
GENERATE_TESTLIST = YES
8990
GENERATE_BUGLIST = YES
90-
GENERATE_DEPRECATEDLIST= YES
91+
GENERATE_DEPRECATEDLIST = YES
9192
ENABLED_SECTIONS =
9293
MAX_INITIALIZER_LINES = 30
9394
SHOW_USED_FILES = YES
@@ -100,14 +101,17 @@ QUIET = NO
100101
WARNINGS = YES
101102
WARN_IF_UNDOCUMENTED = YES
102103
WARN_IF_DOC_ERROR = YES
104+
WARN_IF_INCOMPLETE_DOC = YES
103105
WARN_NO_PARAMDOC = NO
106+
WARN_IF_UNDOC_ENUM_VAL = NO
104107
WARN_AS_ERROR = NO
105108
WARN_FORMAT = "$file:$line: $text"
109+
WARN_LINE_FORMAT = "at line $line of file $file"
106110
WARN_LOGFILE =
107-
INPUT = include/mcpp \
108-
README.md
109-
111+
INPUT = ./include/mcpp \
112+
./README.md
110113
INPUT_ENCODING = UTF-8
114+
INPUT_FILE_ENCODING =
111115
FILE_PATTERNS = *.c \
112116
*.cc \
113117
*.cxx \
@@ -167,6 +171,7 @@ FILTER_PATTERNS =
167171
FILTER_SOURCE_FILES = NO
168172
FILTER_SOURCE_PATTERNS =
169173
USE_MDFILE_AS_MAINPAGE = README.md
174+
FORTRAN_COMMENT_AFTER = 72
170175
SOURCE_BROWSER = NO
171176
INLINE_SOURCES = NO
172177
STRIP_CODE_COMMENTS = YES
@@ -185,23 +190,34 @@ IGNORE_PREFIX =
185190
GENERATE_HTML = YES
186191
HTML_OUTPUT = html
187192
HTML_FILE_EXTENSION = .html
188-
HTML_HEADER =
193+
HTML_HEADER = doxygen-awesome-css/doxygen-custom/header.html
189194
HTML_FOOTER =
190195
HTML_STYLESHEET =
191-
HTML_EXTRA_STYLESHEET =
192-
HTML_EXTRA_FILES =
193-
HTML_COLORSTYLE_HUE = 220
194-
HTML_COLORSTYLE_SAT = 100
195-
HTML_COLORSTYLE_GAMMA = 80
196+
HTML_EXTRA_STYLESHEET = doxygen-awesome-css/doxygen-awesome.css \
197+
doxygen-awesome-css/doxygen-custom/custom.css \
198+
doxygen-awesome-css/doxygen-awesome-sidebar-only.css \
199+
doxygen-awesome-css/doxygen-awesome-sidebar-only-darkmode-toggle.css \
200+
doxygen-awesome-css/doxygen-custom/custom-alternative.css
201+
HTML_EXTRA_FILES = doxygen-awesome-css/doxygen-awesome-darkmode-toggle.js \
202+
doxygen-awesome-css/doxygen-awesome-fragment-copy-button.js \
203+
doxygen-awesome-css/doxygen-awesome-paragraph-link.js \
204+
doxygen-awesome-css/doxygen-custom/toggle-alternative-theme.js \
205+
doxygen-awesome-css/doxygen-awesome-interactive-toc.js \
206+
doxygen-awesome-css/doxygen-awesome-tabs.js
207+
HTML_COLORSTYLE = LIGHT
208+
HTML_COLORSTYLE_HUE = 209
209+
HTML_COLORSTYLE_SAT = 255
210+
HTML_COLORSTYLE_GAMMA = 113
196211
HTML_TIMESTAMP = NO
197212
HTML_DYNAMIC_MENUS = YES
198213
HTML_DYNAMIC_SECTIONS = NO
199214
HTML_INDEX_NUM_ENTRIES = 100
200215
GENERATE_DOCSET = NO
201-
DOCSET_FEEDNAME = "Doxygen generated docs"
202-
DOCSET_BUNDLE_ID = org.doxygen.Project
203-
DOCSET_PUBLISHER_ID = org.doxygen.Publisher
204-
DOCSET_PUBLISHER_NAME = Publisher
216+
DOCSET_FEEDNAME =
217+
DOCSET_FEEDURL =
218+
DOCSET_BUNDLE_ID =
219+
DOCSET_PUBLISHER_ID =
220+
DOCSET_PUBLISHER_NAME =
205221
GENERATE_HTMLHELP = NO
206222
CHM_FILE =
207223
HHC_LOCATION =
@@ -220,15 +236,17 @@ QHG_LOCATION =
220236
GENERATE_ECLIPSEHELP = NO
221237
ECLIPSE_DOC_ID = org.doxygen.Project
222238
DISABLE_INDEX = NO
223-
GENERATE_TREEVIEW = NO
239+
GENERATE_TREEVIEW = YES
240+
FULL_SIDEBAR = NO
224241
ENUM_VALUES_PER_LINE = 4
225-
TREEVIEW_WIDTH = 250
242+
TREEVIEW_WIDTH = 335
226243
EXT_LINKS_IN_WINDOW = NO
244+
OBFUSCATE_EMAILS = YES
227245
HTML_FORMULA_FORMAT = png
228246
FORMULA_FONTSIZE = 10
229-
FORMULA_TRANSPARENT = YES
230247
FORMULA_MACROFILE =
231248
USE_MATHJAX = NO
249+
MATHJAX_VERSION = MathJax_2
232250
MATHJAX_FORMAT = HTML-CSS
233251
MATHJAX_RELPATH = https://cdn.jsdelivr.net/npm/mathjax@2
234252
MATHJAX_EXTENSIONS =
@@ -256,7 +274,6 @@ PDF_HYPERLINKS = YES
256274
USE_PDFLATEX = YES
257275
LATEX_BATCHMODE = NO
258276
LATEX_HIDE_INDICES = NO
259-
LATEX_SOURCE_CODE = NO
260277
LATEX_BIB_STYLE = plain
261278
LATEX_TIMESTAMP = NO
262279
LATEX_EMOJI_DIRECTORY =
@@ -266,7 +283,6 @@ COMPACT_RTF = NO
266283
RTF_HYPERLINKS = NO
267284
RTF_STYLESHEET_FILE =
268285
RTF_EXTENSIONS_FILE =
269-
RTF_SOURCE_CODE = NO
270286
GENERATE_MAN = NO
271287
MAN_OUTPUT = man
272288
MAN_EXTENSION = .3
@@ -276,9 +292,8 @@ GENERATE_XML = NO
276292
XML_OUTPUT = xml
277293
XML_PROGRAMLISTING = YES
278294
XML_NS_MEMB_FILE_SCOPE = NO
279-
GENERATE_DOCBOOK = YES
295+
GENERATE_DOCBOOK = NO
280296
DOCBOOK_OUTPUT = docbook
281-
DOCBOOK_PROGRAMLISTING = NO
282297
GENERATE_AUTOGEN_DEF = NO
283298
GENERATE_PERLMOD = NO
284299
PERLMOD_LATEX = NO
@@ -290,24 +305,24 @@ EXPAND_ONLY_PREDEF = NO
290305
SEARCH_INCLUDES = YES
291306
INCLUDE_PATH =
292307
INCLUDE_FILE_PATTERNS =
293-
PREDEFINED = DOXYGEN_LOGO
308+
PREDEFINED =
294309
EXPAND_AS_DEFINED =
295310
SKIP_FUNCTION_MACROS = YES
296311
TAGFILES =
297312
GENERATE_TAGFILE =
298313
ALLEXTERNALS = NO
299314
EXTERNAL_GROUPS = YES
300315
EXTERNAL_PAGES = YES
301-
CLASS_DIAGRAMS = YES
302316
DIA_PATH =
303317
HIDE_UNDOC_RELATIONS = YES
304318
HAVE_DOT = YES
305319
DOT_NUM_THREADS = 0
306-
DOT_FONTNAME = Helvetica
307-
DOT_FONTSIZE = 10
320+
DOT_COMMON_ATTR = "fontname=Helvetica,fontsize=10"
321+
DOT_EDGE_ATTR = "labelfontname=Helvetica,labelfontsize=10"
322+
DOT_NODE_ATTR = "shape=box,height=0.2,width=0.4"
308323
DOT_FONTPATH =
309324
CLASS_GRAPH = YES
310-
COLLABORATION_GRAPH = YES
325+
COLLABORATION_GRAPH = NO
311326
GROUP_GRAPHS = YES
312327
UML_LOOK = NO
313328
UML_LIMIT_NUM_FIELDS = 10
@@ -320,7 +335,8 @@ CALL_GRAPH = NO
320335
CALLER_GRAPH = NO
321336
GRAPHICAL_HIERARCHY = YES
322337
DIRECTORY_GRAPH = YES
323-
DOT_IMAGE_FORMAT = png
338+
DIR_GRAPH_MAX_DEPTH = 1
339+
DOT_IMAGE_FORMAT = svg
324340
INTERACTIVE_SVG = NO
325341
DOT_PATH =
326342
DOTFILE_DIRS =
@@ -331,7 +347,6 @@ PLANTUML_CFG_FILE =
331347
PLANTUML_INCLUDE_PATH =
332348
DOT_GRAPH_MAX_NODES = 50
333349
MAX_DOT_GRAPH_DEPTH = 0
334-
DOT_TRANSPARENT = NO
335350
DOT_MULTI_TARGETS = NO
336351
GENERATE_LEGEND = YES
337352
DOT_CLEANUP = YES

README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
![mcpp logo](/resources/mcpplogosmall.png)
1+
![mcpp logo](https://raw.githubusercontent.com/rozukke/mcpp/main/resources/mcpplogosmall.png)
22

33

44
# mcpp

doxygen-awesome-css

Submodule doxygen-awesome-css added at f52933b

0 commit comments

Comments
 (0)