修改： pyproject.toml

xinetzone · Jan 7, 2025 · 8b717b1 · 8b717b1
1 parent d472e4a
commit 8b717b1
Show file tree

Hide file tree

Showing 4 changed files with 12 additions and 1 deletion.
diff --git a/doc/.gitignore b/doc/.gitignore
@@ -1,2 +1,2 @@
 media/
-api/
+autoapi/
diff --git a/doc/refs.bib → doc/_static/refs.bib b/doc/refs.bib → doc/_static/refs.bib
diff --git a/doc/conf.py b/doc/conf.py
@@ -34,6 +34,9 @@
     'sphinx_copybutton', # 为代码块添加复制按钮。
     "sphinx_comments", # 为 Sphinx 文档添加评论和注释功能。
     "sphinx.ext.napoleon", # 支持 Google 和 Numpy 风格的文档字符串
+    'sphinxcontrib.mermaid', 
+    "sphinx_proof",
+    "sphinx.ext.todo",
 ]
 
 # 在此添加包含模板的任何路径，相对于此目录。
@@ -213,3 +216,9 @@
         "sbt-sidebar-nav.html",
     ]
 }
+
+# ===================== 可选 ==========================================================
+# 用户可以使用 BibTeX 格式的参考文献数据库，并在文档中插入引用和生成参考文献列表。
+# -------------------------------------------------------------------------------------
+extensions.append('sphinxcontrib.bibtex')
+bibtex_bibfiles = ['_static/refs.bib',]
diff --git a/pyproject.toml b/pyproject.toml
@@ -42,6 +42,8 @@ doc = [
     "sphinx-sitemap",
     "sphinx-autoapi",
     "graphviz",
+    "sphinxcontrib-mermaid",
+    "sphinx-proof",
 ]
 
 flows = [