Skip to content

Commit 4e84308

Browse files
committed
⚙️ Update Doxygen configuration for bilingual documentation
- Enable Unicode names for Chinese character support - Add comprehensive aliases for documentation organization - Include both EN/ZH tutorial directories in input paths - Enhance navigation with dynamic sections and expanded TOC - Update main page to use new bilingual index structure - Improve HTML output settings for better user experience - Add tag file generation for cross-referencing - Update MathJax to version 3 for better performance - Configure example paths to include algorithm tutorials
1 parent bd2608e commit 4e84308

File tree

1 file changed

+34
-23
lines changed

1 file changed

+34
-23
lines changed

Doxyfile

Lines changed: 34 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,20 @@
11
# Doxygen Configuration for ZLayout
22
# Advanced Electronic Design Automation Layout Library
33
#
4-
# This configuration generates comprehensive documentation for both C++ and Python APIs
5-
# Optimized for GitHub Pages deployment and Windows development environment
4+
# This configuration generates comprehensive bilingual documentation for both C++ and Python APIs
5+
# Optimized for GitHub Pages deployment with enhanced navigation and tutorial integration
66

77
#---------------------------------------------------------------------------
88
# Project related configuration options
99
#---------------------------------------------------------------------------
1010
DOXYFILE_ENCODING = UTF-8
11-
PROJECT_NAME = "ZLayout"
11+
PROJECT_NAME = "ZLayout EDA Library"
1212
PROJECT_NUMBER = "v1.0.0"
13-
PROJECT_BRIEF = "Advanced Electronic Design Automation Layout Library"
13+
PROJECT_BRIEF = "Advanced Electronic Design Automation Layout Library with Bilingual Documentation"
1414
PROJECT_LOGO =
1515
OUTPUT_DIRECTORY = docs/generated
1616
CREATE_SUBDIRS = YES
17-
ALLOW_UNICODE_NAMES = NO
17+
ALLOW_UNICODE_NAMES = YES
1818
OUTPUT_LANGUAGE = English
1919
BRIEF_MEMBER_DESC = YES
2020
REPEAT_BRIEF = YES
@@ -42,15 +42,21 @@ MULTILINE_CPP_IS_BRIEF = NO
4242
INHERIT_DOCS = YES
4343
SEPARATE_MEMBER_PAGES = NO
4444
TAB_SIZE = 4
45-
ALIASES =
45+
ALIASES = "complexity=\par Complexity Analysis:\n" \
46+
"performance=\par Performance:\n" \
47+
"tutorial=\par Tutorial:\n" \
48+
"algorithm=\par Algorithm:\n" \
49+
"chinese=\par 中文:\n" \
50+
"english=\par English:\n" \
51+
"bilingual=\par Bilingual Support:\n"
4652
OPTIMIZE_OUTPUT_FOR_C = NO
4753
OPTIMIZE_OUTPUT_JAVA = NO
4854
OPTIMIZE_FOR_FORTRAN = NO
4955
OPTIMIZE_OUTPUT_VHDL = NO
5056
OPTIMIZE_OUTPUT_SLICE = NO
51-
EXTENSION_MAPPING =
57+
EXTENSION_MAPPING = .py=Python
5258
MARKDOWN_SUPPORT = YES
53-
TOC_INCLUDE_HEADINGS = 5
59+
TOC_INCLUDE_HEADINGS = 6
5460
AUTOLINK_SUPPORT = YES
5561
BUILTIN_STL_SUPPORT = YES
5662
CPP_CLI_SUPPORT = NO
@@ -126,8 +132,10 @@ INPUT = include \
126132
zlayout \
127133
examples \
128134
benchmarks \
129-
docs/tutorials \
135+
docs/tutorials/en \
136+
docs/tutorials/zh \
130137
docs/examples \
138+
docs/index.md \
131139
README.md \
132140
README_EN.md
133141
INPUT_ENCODING = UTF-8
@@ -189,6 +197,8 @@ EXCLUDE_PATTERNS = */build/* \
189197
EXCLUDE_SYMBOLS =
190198
EXAMPLE_PATH = examples \
191199
docs/examples \
200+
docs/tutorials/en/algorithms \
201+
docs/tutorials/zh/algorithms \
192202
benchmarks
193203
EXAMPLE_PATTERNS = *
194204
EXAMPLE_RECURSIVE = YES
@@ -197,7 +207,7 @@ INPUT_FILTER =
197207
FILTER_PATTERNS =
198208
FILTER_SOURCE_FILES = NO
199209
FILTER_SOURCE_PATTERNS =
200-
USE_MDFILE_AS_MAINPAGE = README.md
210+
USE_MDFILE_AS_MAINPAGE = docs/index.md
201211

202212
#---------------------------------------------------------------------------
203213
# Configuration options related to source browsing
@@ -238,41 +248,41 @@ HTML_COLORSTYLE_SAT = 100
238248
HTML_COLORSTYLE_GAMMA = 80
239249
HTML_TIMESTAMP = NO
240250
HTML_DYNAMIC_MENUS = YES
241-
HTML_DYNAMIC_SECTIONS = NO
251+
HTML_DYNAMIC_SECTIONS = YES
242252
HTML_INDEX_NUM_ENTRIES = 100
243253
GENERATE_DOCSET = NO
244-
DOCSET_FEEDNAME = "Doxygen generated docs"
245-
DOCSET_BUNDLE_ID = org.doxygen.Project
246-
DOCSET_PUBLISHER_ID = org.doxygen.Publisher
247-
DOCSET_PUBLISHER_NAME = Publisher
254+
DOCSET_FEEDNAME = "ZLayout EDA Documentation"
255+
DOCSET_BUNDLE_ID = org.zlayout.docs
256+
DOCSET_PUBLISHER_ID = org.zlayout.publisher
257+
DOCSET_PUBLISHER_NAME = ZLayout Team
248258
GENERATE_HTMLHELP = NO
249259
CHM_FILE =
250260
HHC_LOCATION =
251261
GENERATE_CHI = NO
252262
CHM_INDEX_ENCODING =
253263
BINARY_TOC = NO
254-
TOC_EXPAND = NO
264+
TOC_EXPAND = YES
255265
GENERATE_QHP = NO
256266
QCH_FILE =
257-
QHP_NAMESPACE = org.doxygen.Project
267+
QHP_NAMESPACE = org.zlayout.Project
258268
QHP_VIRTUAL_FOLDER = doc
259269
QHP_CUST_FILTER_NAME =
260270
QHP_CUST_FILTER_ATTRS =
261271
QHP_SECT_FILTER_ATTRS =
262272
QHG_LOCATION =
263273
GENERATE_ECLIPSEHELP = NO
264-
ECLIPSE_DOC_ID = org.doxygen.Project
274+
ECLIPSE_DOC_ID = org.zlayout.Project
265275
DISABLE_INDEX = NO
266276
GENERATE_TREEVIEW = YES
267277
ENUM_VALUES_PER_LINE = 4
268-
TREEVIEW_WIDTH = 250
269-
EXT_LINKS_IN_WINDOW = NO
278+
TREEVIEW_WIDTH = 300
279+
EXT_LINKS_IN_WINDOW = YES
270280
FORMULA_FONTSIZE = 10
271281
FORMULA_TRANSPARENT = YES
272282
FORMULA_MACROFILE =
273283
USE_MATHJAX = YES
274284
MATHJAX_FORMAT = HTML-CSS
275-
MATHJAX_RELPATH = https://cdn.jsdelivr.net/npm/mathjax@2
285+
MATHJAX_RELPATH = https://cdn.jsdelivr.net/npm/mathjax@3
276286
MATHJAX_EXTENSIONS =
277287
MATHJAX_CODEFILE =
278288
SEARCHENGINE = YES
@@ -367,15 +377,16 @@ INCLUDE_FILE_PATTERNS =
367377
PREDEFINED = DOXYGEN_SHOULD_SKIP_THIS \
368378
ZLAYOUT_EXPORTS \
369379
ZLAYOUT_OPENMP \
370-
ZLAYOUT_VISUALIZATION
380+
ZLAYOUT_VISUALIZATION \
381+
ZLAYOUT_BILINGUAL_DOCS
371382
EXPAND_AS_DEFINED =
372383
SKIP_FUNCTION_MACROS = YES
373384

374385
#---------------------------------------------------------------------------
375386
# Configuration options related to external references
376387
#---------------------------------------------------------------------------
377388
TAGFILES =
378-
GENERATE_TAGFILE =
389+
GENERATE_TAGFILE = zlayout.tag
379390
ALLEXTERNALS = NO
380391
EXTERNAL_GROUPS = YES
381392
EXTERNAL_PAGES = YES

0 commit comments

Comments
 (0)