更新文档

Author: xinetzone

doc/conf.py

@@ -34,6 +34,7 @@
     'sphinx_copybutton', # 为代码块添加复制按钮。
     "sphinx_comments", # 为 Sphinx 文档添加评论和注释功能。
     "sphinx.ext.napoleon", # 支持 Google 和 Numpy 风格的文档字符串
+    "sphinxcontrib.mermaid",
 ]
 
 # 在此添加包含模板的任何路径，相对于此目录。
@@ -243,3 +244,13 @@
 breathe_projects = { "cpp-examples": "xml/" }
 
 breathe_default_project = "cpp-examples"
+
+
+# 如果你希望stderr和stdout中的每个输出都被合并成一个流，请使用以下配置。
+# 避免将 jupter 执行报错的信息输出到 cmd
+nb_merge_streams = True
+nb_execution_allow_errors = True
+nb_execution_mode = "off"
+
+# 配置mermaid参数
+mermaid_params = ['--theme', 'forest']

doc/draft/test.rst

@@ -9,41 +9,14 @@
     "{func}`std::accumulate` 是 C++ 标准模板库(STL)中的函数，用于返回一系列值的总和。它接受三个参数："
    ]
   },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {
-    "vscode": {
-     "languageId": "plaintext"
-    }
-   },
-   "outputs": [],
-   "source": [
-    " std::vector<int> numbers = {1, 2, 3, 4, 5};\n",
-    "\n",
-    "    int sum = std::accumulate(numbers.begin(), numbers.end(), 0); // sum starts at zero"
-   ]
-  },
   {
    "cell_type": "code",
    "execution_count": 2,
    "metadata": {},
-   "outputs": [
-    {
-     "data": {
-      "text/plain": [
-       "15"
-      ]
-     },
-     "execution_count": 2,
-     "metadata": {},
-     "output_type": "execute_result"
-    }
-   ],
+   "outputs": [],
    "source": [
     "std::vector<int> numbers = {1, 2, 3, 4, 5};\n",
-    "\n",
-    "std::accumulate(numbers.begin(), numbers.end(), 0)"
+    "int sum = std::accumulate(numbers.begin(), numbers.end(), 0); // sum starts at zero"
    ]
   },
   {

doc/exercises/accumulate.ipynb

@@ -35,11 +35,7 @@
   {
    "cell_type": "code",
    "execution_count": 1,
-   "metadata": {
-    "vscode": {
-     "languageId": "c++"
-    }
-   },
+   "metadata": {},
    "outputs": [],
    "source": [
     "extern \"C\"\n",
@@ -56,11 +52,7 @@
   {
    "cell_type": "code",
    "execution_count": null,
-   "metadata": {
-    "vscode": {
-     "languageId": "c++"
-    }
-   },
+   "metadata": {},
    "outputs": [],
    "source": []
   }
@@ -75,7 +67,7 @@
    "codemirror_mode": "text/x-c++src",
    "file_extension": ".cpp",
    "mimetype": "text/x-c++src",
-   "name": "C++14",
+   "name": "c++",
    "version": "14"
   }
  },

doc/exercises/c2cpp.ipynb

@@ -15,29 +15,10 @@
    ]
   },
   {
-   "cell_type": "code",
-   "execution_count": 1,
+   "cell_type": "markdown",
    "metadata": {},
-   "outputs": [
-    {
-     "name": "stderr",
-     "output_type": "stream",
-     "text": [
-      "input_line_8:1:10: fatal error: 'cppExample.h' file not found\n",
-      "#include \"cppExample.h\"\n",
-      "         ^~~~~~~~~~~~~~\n"
-     ]
-    },
-    {
-     "ename": "Interpreter Error",
-     "evalue": "",
-     "output_type": "error",
-     "traceback": [
-      "Interpreter Error: "
-     ]
-    }
-   ],
    "source": [
+    "```c\n",
     "//C++头文件 cppExample.h\n",
     "#ifndef CPP_EXAMPLE_H\n",
     "#define CPP_EXAMPLE_H\n",
@@ -59,7 +40,8 @@
     "{\n",
     "    add( 2, 3 );   \n",
     "    return 0;\n",
-    "}"
+    "}\n",
+    "``"
    ]
   },
   {

doc/exercises/cpp2c.ipynb

@@ -34,12 +34,17 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 1,
-   "metadata": {
-    "vscode": {
-     "languageId": "c++"
-    }
-   },
+   "execution_count": 2,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "#include <iostream>"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 3,
+   "metadata": {},
    "outputs": [
     {
      "name": "stdout",
@@ -50,9 +55,6 @@
     }
    ],
    "source": [
-    "#include <math.h>\n",
-    "#include <iostream>\n",
-    "\n",
     "double x, y;\n",
     "int n;\n",
     "x = 16.4;\n",
@@ -73,27 +75,10 @@
     "将双精度有效数字转换为整数有效数字，即将小数点放在第 31 位和第 30 位之间。这是通过将双精度值乘以 $2^{31}$，然后将其转换为 int 来实现的。"
    ]
   },
-  {
-   "cell_type": "code",
-   "execution_count": 3,
-   "metadata": {
-    "vscode": {
-     "languageId": "c++"
-    }
-   },
-   "outputs": [],
-   "source": [
-    "significand_d = std::round(significand_d * (1ll << 31));"
-   ]
-  },
   {
    "cell_type": "code",
    "execution_count": null,
-   "metadata": {
-    "vscode": {
-     "languageId": "c++"
-    }
-   },
+   "metadata": {},
    "outputs": [],
    "source": []
   }
@@ -108,7 +93,7 @@
    "codemirror_mode": "text/x-c++src",
    "file_extension": ".cpp",
    "mimetype": "text/x-c++src",
-   "name": "C++14",
+   "name": "c++",
    "version": "14"
   },
   "orig_nbformat": 4

doc/exercises/frexp.ipynb

@@ -23,14 +23,14 @@ doc = [
     "sphinx",
     # "ablog",
     "ipywidgets",
-    "folium",
+    # "folium",
     "numpy",
     "matplotlib",
     "sphinx-comments",
     "myst-nb",
     "nbclient",
     "pandas",
-    "plotly",
+    # "plotly",
     "sphinx-design",
     "sphinx-examples",
     "sphinx-copybutton",
@@ -41,10 +41,11 @@ doc = [
     "sphinx-sitemap",
     "sphinx-autoapi>=3.4",
     "graphviz",
-    "sphinx-intl", # 文档国际化
+    # "sphinx-intl", # 文档国际化
     "sphinx-tippy",
     "taolib[flows]",
     "breathe",
+    "sphinxcontrib-mermaid",
 ]
 
 flows = [