Merge pull request #931 from icecraft/fix/docs_style

fix: typo

next_docs/zh_cn/user_guide/install/boost_with_cuda.rst

@@ -30,14 +30,14 @@
 
 Ubuntu 22.04 LTS
 ----------------
-1. 检测是否已安装nvidia驱动
+1. 检测是否已安装 nvidia 驱动
 ---------------------------
 
 .. code:: bash
 
    nvidia-smi
 
-如果看到类似如下的信息，说明已经安装了nvidia驱动，可以跳过步骤2
+如果看到类似如下的信息，说明已经安装了 nvidia 驱动，可以跳过步骤2
 
 .. admonition:: Important
     :class: tip
@@ -74,10 +74,10 @@ Ubuntu 22.04 LTS
 
    reboot
 
-3. 安装anacoda
+3. 安装 anacoda
 --------------
 
-如果已安装conda，可以跳过本步骤
+如果已安装 conda，可以跳过本步骤
 
 .. code:: bash
 
@@ -86,10 +86,10 @@ Ubuntu 22.04 LTS
 
 最后一步输入yes，关闭终端重新打开
 
-4. 使用conda 创建环境
+4. 使用 conda 创建环境
 ---------------------
 
-需指定python版本为3.10
+需指定 python 版本为3.10
 
 .. code:: bash
 
@@ -145,15 +145,15 @@ Ubuntu 22.04 LTS
 如果您的显卡显存大于等于 **8GB**
 ，可以进行以下流程，测试CUDA解析加速效果
 
-**1.修改【用户目录】中配置文件magic-pdf.json中”device-mode”的值**
+**1.修改【用户目录】中配置文件 magic-pdf.json 中”device-mode”的值**
 
 .. code:: json
 
    {
      "device-mode":"cuda"
    }
 
-**2.运行以下命令测试cuda加速效果**
+**2.运行以下命令测试 cuda 加速效果**
 
 .. code:: bash
 
@@ -163,9 +163,9 @@ Ubuntu 22.04 LTS
 .. admonition:: Tip
     :class: tip
 
-    CUDA加速是否生效可以根据log中输出的各个阶段cost耗时来简单判断，通常情况下， ``layout detection cost`` 和 ``mfr time`` 应提速10倍以上。
+    CUDA 加速是否生效可以根据 log 中输出的各个阶段 cost 耗时来简单判断，通常情况下， ``layout detection cost`` 和 ``mfr time`` 应提速10倍以上。
 
-10. 为ocr开启cuda加速
+10. 为 ocr 开启 cuda 加速
 ---------------------
 
 **1.下载paddlepaddle-gpu, 安装完成后会自动开启ocr加速**
@@ -183,30 +183,30 @@ Ubuntu 22.04 LTS
 .. admonition:: Tip
     :class: tip
 
-    CUDA加速是否生效可以根据log中输出的各个阶段cost耗时来简单判断，通常情况下， ``ocr cost`` 应提速10倍以上。
+    CUDA 加速是否生效可以根据 log 中输出的各个阶段 cost 耗时来简单判断，通常情况下， ``ocr cost`` 应提速10倍以上。
 
 
 .. _windows_10_or_11_section:
 
 Windows 10/11
 --------------
 
-1. 安装cuda和cuDNN
+1. 安装 cuda 和 cuDNN
 ------------------
 
 需要安装的版本 CUDA 11.8 + cuDNN 8.7.0
 
 -  CUDA 11.8 https://developer.nvidia.com/cuda-11-8-0-download-archive
 -  cuDNN v8.7.0 (November 28th, 2022), for CUDA 11.x https://developer.nvidia.com/rdp/cudnn-archive
 
-2. 安装anaconda
+2. 安装 anaconda
 ---------------
 
-如果已安装conda，可以跳过本步骤
+如果已安装 conda，可以跳过本步骤
 
 下载链接：https://mirrors.tuna.tsinghua.edu.cn/anaconda/archive/Anaconda3-2024.06-1-Windows-x86_64.exe
 
-3. 使用conda 创建环境
+3. 使用 conda 创建环境
 ---------------------
 
 需指定python版本为3.10
@@ -242,12 +242,12 @@ Windows 10/11
 6. 了解配置文件存放的位置
 -------------------------
 
-完成\ `5.下载模型 <#5-下载模型>`__\ 步骤后，脚本会自动生成用户目录下的magic-pdf.json文件，并自动配置默认模型路径。您可在【用户目录】下找到magic-pdf.json文件。
+完成\ `5.下载模型 <#5-下载模型>`__\ 步骤后，脚本会自动生成用户目录下的magic-pdf.json文件，并自动配置默认模型路径。您可在【用户目录】下找到 magic-pdf.json 文件。
 
 .. admonition:: Tip
     :class: tip
 
-    windows用户目录为 “C:/Users/用户名”
+    windows 用户目录为 “C:/Users/用户名”
 
 7. 第一次运行
 -------------
@@ -259,10 +259,10 @@ Windows 10/11
     wget https://github.com/opendatalab/MinerU/raw/master/demo/small_ocr.pdf -O small_ocr.pdf
     magic-pdf -p small_ocr.pdf -o ./output
 
-8. 测试CUDA加速
+8. 测试 CUDA 加速
 ---------------
 
-如果您的显卡显存大于等于 **8GB**，可以进行以下流程，测试CUDA解析加速效果
+如果您的显卡显存大于等于 **8GB**，可以进行以下流程，测试 CUDA 解析加速效果
 
 **1.覆盖安装支持cuda的torch和torchvision**
 
@@ -298,9 +298,9 @@ Windows 10/11
 .. admonition:: Tip
     :class: tip
 
-    CUDA加速是否生效可以根据log中输出的各个阶段的耗时来简单判断，通常情况下， ``layout detection time`` 和 ``mfr time`` 应提速10倍以上。
+    CUDA 加速是否生效可以根据 log 中输出的各个阶段的耗时来简单判断，通常情况下， ``layout detection time`` 和 ``mfr time`` 应提速10倍以上。
 
-9. 为ocr开启cuda加速
+9. 为 ocr 开启 cuda 加速
 --------------------
 
 **1.下载paddlepaddle-gpu, 安装完成后会自动开启ocr加速**
@@ -318,4 +318,4 @@ Windows 10/11
 .. admonition:: Tip
     :class: tip
 
-    CUDA加速是否生效可以根据log中输出的各个阶段cost耗时来简单判断，通常情况下， ``ocr time`` 应提速10倍以上。
+    CUDA 加速是否生效可以根据 log 中输出的各个阶段 cost 耗时来简单判断，通常情况下， ``ocr time`` 应提速10倍以上。

next_docs/zh_cn/user_guide/install/download_model_weight_files.rst

@@ -25,7 +25,7 @@ python脚本会自动下载模型文件并配置好配置文件中的模型目
 方法二：从 ModelScope 下载模型
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
-使用python脚本 从ModelScope下载模型文件
+使用python脚本从 ModelScope 下载模型文件
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 .. code:: bash
@@ -46,7 +46,7 @@ python脚本会自动下载模型文件并配置好配置文件中的模型目
 此前下载过模型，如何更新
 --------------------
 
-1. 通过git lfs下载过模型
+1. 通过 git lfs 下载过模型
 ^^^^^^^^^^^^^^^^^^^^^^^
 
 .. admonition:: Important
@@ -61,4 +61,4 @@ python脚本会自动下载模型文件并配置好配置文件中的模型目
 2. 通过 Hugging Face 或 Model Scope 下载过模型
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
-如此前通过 HuggingFace 或 Model Scope 下载过模型，可以重复执行此前的模型下载python脚本，将会自动将模型目录更新到最新版本。
+如此前通过 HuggingFace 或 Model Scope 下载过模型，可以重复执行此前的模型下载 python 脚本，将会自动将模型目录更新到最新版本。

next_docs/zh_cn/user_guide/install/install.rst

@@ -7,13 +7,13 @@
 .. admonition:: Warning
     :class: tip
 
-   **安装前必看——软硬件环境支持说明**
+    **安装前必看——软硬件环境支持说明**
 
-   为了确保项目的稳定性和可靠性，我们在开发过程中仅对特定的软硬件环境进行优化和测试。这样当用户在推荐的系统配置上部署和运行项目时，能够获得最佳的性能表现和最少的兼容性问题。
+    为了确保项目的稳定性和可靠性，我们在开发过程中仅对特定的软硬件环境进行优化和测试。这样当用户在推荐的系统配置上部署和运行项目时，能够获得最佳的性能表现和最少的兼容性问题。
 
-   通过集中资源和精力于主线环境，我们团队能够更高效地解决潜在的BUG，及时开发新功能。
+    通过集中资源和精力于主线环境，我们团队能够更高效地解决潜在的BUG，及时开发新功能。
 
-   在非主线环境中，由于硬件、软件配置的多样性，以及第三方依赖项的兼容性问题，我们无法100%保证项目的完全可用性。因此，对于希望在非推荐环境中使用本项目的用户，我们建议先仔细阅读文档以及 :doc:`../../additional_notes/faq` ，大多数问题已经在 :doc:`../../additional_notes/faq` 中有对应的解决方案，除此之外我们鼓励社区反馈问题，以便我们能够逐步扩大支持范围。
+    在非主线环境中，由于硬件、软件配置的多样性，以及第三方依赖项的兼容性问题，我们无法100%保证项目的完全可用性。因此，对于希望在非推荐环境中使用本项目的用户，我们建议先仔细阅读文档以及 :doc:`../../additional_notes/faq` ，大多数问题已经在 :doc:`../../additional_notes/faq` 中有对应的解决方案，除此之外我们鼓励社区反馈问题，以便我们能够逐步扩大支持范围。
 
 .. raw:: html
 

next_docs/zh_cn/user_guide/quick_start/to_markdown.rst

@@ -49,5 +49,5 @@
         md_writer.write_string(f"{pdf_file_name}.md", md_content)
 
 
-前去 :doc:`../data/data_reader_writer` 获取更多有关**读写**示例
+前去 :doc:`../data/data_reader_writer` 获取更多有关 **读写** 示例