update README.md

Author: flyingcys

docs/en/conf.py

@@ -14,7 +14,14 @@
 # -- General configuration ---------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
 
-extensions = ['myst_parser','sphinx_markdown_tables','sphinx_copybutton']
+extensions = [
+    'myst_parser',
+    'sphinx_markdown_tables',
+    'sphinx_copybutton',
+    'sphinxcontrib.mermaid',
+    'sphinx_design',
+    'sphinx_sitemap',
+]
 
 templates_path = ['_templates']
 exclude_patterns = []

docs/requirements.txt

@@ -1,3 +1,9 @@
+Sphinx
+sphinx-sitemap
+sphinxcontrib-jsmath
+sphinx-design
+sphinx-reredirects
+typing-extensions
 sphinx-markdown-tables>=0.0.17
 sphinx-rtd-theme>=2.0.0
 recommonmark>=0.7.1

docs/zh/conf.py

@@ -14,7 +14,14 @@
 # -- General configuration ---------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
 
-extensions = ['myst_parser','sphinx_markdown_tables','sphinx_copybutton']
+extensions = [
+    'myst_parser',
+    'sphinx_markdown_tables',
+    'sphinx_copybutton',
+    'sphinxcontrib.mermaid',
+    'sphinx_design',
+    'sphinx_sitemap',
+]
 
 templates_path = ['_templates']
 exclude_patterns = []
@@ -34,16 +41,16 @@ def setup(app):
 
 html_theme_options = {
     'display_version': True,
-    'prev_next_buttons_location': 'both',
-    'style_external_links': False,
-    'sticky_navigation': True,
-    'navigation_depth': 4,
-    'includehidden': True,
-    'titles_only': False,
-    'collapse_navigation': False,
-    'logo_only': True,
-    'body_max_width': None,  # 取消页面宽度限制
-    'sidebarwidth': '25%',  # 调整侧边栏宽度
+    'prev_next_buttons_location': 'both',           # 在文档页面的顶部和底部同时显示 "上一页 / 下一页" 导航按钮。
+    'style_external_links': False,                  # 允许外部链接的样式。
+    'sticky_navigation': True,                      # 使侧边栏导航菜单在页面滚动时保持固定位置。
+    'navigation_depth': 4,                          # 设置侧边栏导航的最大层级深度为 4 级
+    'includehidden': True,                          # 禁用导航菜单的自动折叠功能
+    'titles_only': False,                           # 禁用页面标题的显示
+    'collapse_navigation': False,                   # 禁用导航菜单的自动折叠功能
+    'logo_only': True,                              # 仅显示 Logo
+    'body_max_width': None,                         # 取消页面宽度限制
+    'sidebarwidth': '25%',                          # 调整侧边栏宽度
 }
 
 html_js_files = [
@@ -62,3 +69,7 @@ def setup(app):
     # 页面路径配置（自动生成编辑链接）
     "conf_py_path": "/docs/zh/",  # 配置文件的仓库相对路径
 }
+
+highlight_language = 'c'  # 默认高亮C语言代码
+primary_domain = 'c'      # 主文档域为C语言
+