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#---------------------------------------------------------------------------
1010DOXYFILE_ENCODING = UTF-8
11- PROJECT_NAME = "ZLayout"
11+ PROJECT_NAME = "ZLayout EDA Library "
1212PROJECT_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 "
1414PROJECT_LOGO =
1515OUTPUT_DIRECTORY = docs/generated
1616CREATE_SUBDIRS = YES
17- ALLOW_UNICODE_NAMES = NO
17+ ALLOW_UNICODE_NAMES = YES
1818OUTPUT_LANGUAGE = English
1919BRIEF_MEMBER_DESC = YES
2020REPEAT_BRIEF = YES
@@ -42,15 +42,21 @@ MULTILINE_CPP_IS_BRIEF = NO
4242INHERIT_DOCS = YES
4343SEPARATE_MEMBER_PAGES = NO
4444TAB_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"
4652OPTIMIZE_OUTPUT_FOR_C = NO
4753OPTIMIZE_OUTPUT_JAVA = NO
4854OPTIMIZE_FOR_FORTRAN = NO
4955OPTIMIZE_OUTPUT_VHDL = NO
5056OPTIMIZE_OUTPUT_SLICE = NO
51- EXTENSION_MAPPING =
57+ EXTENSION_MAPPING = .py=Python
5258MARKDOWN_SUPPORT = YES
53- TOC_INCLUDE_HEADINGS = 5
59+ TOC_INCLUDE_HEADINGS = 6
5460AUTOLINK_SUPPORT = YES
5561BUILTIN_STL_SUPPORT = YES
5662CPP_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
133141INPUT_ENCODING = UTF-8
@@ -189,6 +197,8 @@ EXCLUDE_PATTERNS = */build/* \
189197EXCLUDE_SYMBOLS =
190198EXAMPLE_PATH = examples \
191199 docs/examples \
200+ docs/tutorials/en/algorithms \
201+ docs/tutorials/zh/algorithms \
192202 benchmarks
193203EXAMPLE_PATTERNS = *
194204EXAMPLE_RECURSIVE = YES
@@ -197,7 +207,7 @@ INPUT_FILTER =
197207FILTER_PATTERNS =
198208FILTER_SOURCE_FILES = NO
199209FILTER_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
238248HTML_COLORSTYLE_GAMMA = 80
239249HTML_TIMESTAMP = NO
240250HTML_DYNAMIC_MENUS = YES
241- HTML_DYNAMIC_SECTIONS = NO
251+ HTML_DYNAMIC_SECTIONS = YES
242252HTML_INDEX_NUM_ENTRIES = 100
243253GENERATE_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
248258GENERATE_HTMLHELP = NO
249259CHM_FILE =
250260HHC_LOCATION =
251261GENERATE_CHI = NO
252262CHM_INDEX_ENCODING =
253263BINARY_TOC = NO
254- TOC_EXPAND = NO
264+ TOC_EXPAND = YES
255265GENERATE_QHP = NO
256266QCH_FILE =
257- QHP_NAMESPACE = org.doxygen .Project
267+ QHP_NAMESPACE = org.zlayout .Project
258268QHP_VIRTUAL_FOLDER = doc
259269QHP_CUST_FILTER_NAME =
260270QHP_CUST_FILTER_ATTRS =
261271QHP_SECT_FILTER_ATTRS =
262272QHG_LOCATION =
263273GENERATE_ECLIPSEHELP = NO
264- ECLIPSE_DOC_ID = org.doxygen .Project
274+ ECLIPSE_DOC_ID = org.zlayout .Project
265275DISABLE_INDEX = NO
266276GENERATE_TREEVIEW = YES
267277ENUM_VALUES_PER_LINE = 4
268- TREEVIEW_WIDTH = 250
269- EXT_LINKS_IN_WINDOW = NO
278+ TREEVIEW_WIDTH = 300
279+ EXT_LINKS_IN_WINDOW = YES
270280FORMULA_FONTSIZE = 10
271281FORMULA_TRANSPARENT = YES
272282FORMULA_MACROFILE =
273283USE_MATHJAX = YES
274284MATHJAX_FORMAT = HTML-CSS
275- MATHJAX_RELPATH = https://cdn.jsdelivr.net/npm/mathjax@2
285+ MATHJAX_RELPATH = https://cdn.jsdelivr.net/npm/mathjax@3
276286MATHJAX_EXTENSIONS =
277287MATHJAX_CODEFILE =
278288SEARCHENGINE = YES
@@ -367,15 +377,16 @@ INCLUDE_FILE_PATTERNS =
367377PREDEFINED = DOXYGEN_SHOULD_SKIP_THIS \
368378 ZLAYOUT_EXPORTS \
369379 ZLAYOUT_OPENMP \
370- ZLAYOUT_VISUALIZATION
380+ ZLAYOUT_VISUALIZATION \
381+ ZLAYOUT_BILINGUAL_DOCS
371382EXPAND_AS_DEFINED =
372383SKIP_FUNCTION_MACROS = YES
373384
374385#---------------------------------------------------------------------------
375386# Configuration options related to external references
376387#---------------------------------------------------------------------------
377388TAGFILES =
378- GENERATE_TAGFILE =
389+ GENERATE_TAGFILE = zlayout.tag
379390ALLEXTERNALS = NO
380391EXTERNAL_GROUPS = YES
381392EXTERNAL_PAGES = YES
0 commit comments