From 257e971c014f8867ef98e5e9a89a714bc51234f3 Mon Sep 17 00:00:00 2001 From: Dongdong Tian Date: Tue, 5 Nov 2024 10:42:18 +0800 Subject: [PATCH] Fix references to other docs (#717) --- source/computer/command-line.md | 2 +- source/computer/fedora-setup.md | 2 +- source/computer/file-operations.md | 4 ++-- source/computer/macos-setup.md | 2 +- source/computer/operating-system.md | 6 +++--- source/computer/ubuntu-setup.md | 2 +- source/computer/wsl-setup.md | 4 ++-- source/exercises/download.md | 6 +++--- source/exercises/prerequisite.md | 2 +- source/exercises/software.md | 2 +- source/programming/bash.md | 4 ++-- source/programming/editor.md | 2 +- source/programming/python.md | 2 +- source/seismology/seismic-phase.md | 2 +- 14 files changed, 21 insertions(+), 21 deletions(-) diff --git a/source/computer/command-line.md b/source/computer/command-line.md index ba4f306a1..5d9381ec7 100644 --- a/source/computer/command-line.md +++ b/source/computer/command-line.md @@ -39,7 +39,7 @@ $ exit 从终端程序输入的指令，会被一个称为 Shell（壳）的程序接收，并进一步交给系统执行。 几乎所有的 Linux 发行版都提供了一个叫 Bash 的 Shell，此外还有 Zsh、csh、ksh 等 Shell。 -熟悉 Linux 系统之后，推荐参考{doc}`《Zsh 及其配置实践经验》`安装和使用 Zsh。 +熟悉 Linux 系统之后，推荐参考[《Zsh 及其配置实践经验》](/best-practices/zsh) 安装和使用 Zsh。 打开终端后，通常会看到类似如下 Shell 提示符: diff --git a/source/computer/fedora-setup.md b/source/computer/fedora-setup.md index 8b13c4051..79f2d5ba6 100644 --- a/source/computer/fedora-setup.md +++ b/source/computer/fedora-setup.md @@ -171,7 +171,7 @@ Fedora 会弹出提醒通知。建议用户及时更新系统及已安装的软 :::{warning} 更新系统前，特别是大版本更新（如 Fedora 35 更新为 Fedora 36）， -最好先进行一次备份（可以参考{doc}`/best-practices/backup`）。 +最好先进行一次备份（可以参考[](/best-practices/backup)）。 ::: :::{note} diff --git a/source/computer/file-operations.md b/source/computer/file-operations.md index 5212793f2..6fbdaa98b 100644 --- a/source/computer/file-operations.md +++ b/source/computer/file-operations.md @@ -28,8 +28,8 @@ Linux 文件系统就像一颗树一样，从 {file}`/` 目录开始，这个特 该用户的家目录便是 {file}`/home/seismo-learn`。macOS 下的家目录是 {file}`/Users/seismo-learn`。 在 Linux/macOS 系统下，可用 {file}`~` 代表家目录。Linux 系统安装后，自动创建的家目录下的目录有 {file}`~/Desktop`、{file}`~/Documents`、{file}`~/Downloads` 等。熟悉 Linux 文件系统后 -可以参考{doc}`《文件管理实践经验》`和 -{doc}`《软件安装实践经验》`进一步组织与管理家目录， +可以参考 [《文件管理实践经验》](/best-practices/file-organization) 和 +[《软件安装实践经验》](/best-practices/software-installation) 进一步组织与管理家目录， 以提高工作效率。 ## 操作文件与目录 diff --git a/source/computer/macos-setup.md b/source/computer/macos-setup.md index 1f811b491..dd6e53e9d 100644 --- a/source/computer/macos-setup.md +++ b/source/computer/macos-setup.md @@ -21,7 +21,7 @@ macOS 系统的更新也十分简单。当有新版本发布以后，在“系 :::{warning} 更新系统前，特别是大版本更新（如 macOS 11 更新为 macOS 12）， -最好先备份一下（可以参考{doc}`/best-practices/backup`）。 +最好先备份一下（可以参考[](/best-practices/backup)）。 ::: :::{note} diff --git a/source/computer/operating-system.md b/source/computer/operating-system.md index 170920530..5ea89d228 100644 --- a/source/computer/operating-system.md +++ b/source/computer/operating-system.md @@ -28,7 +28,7 @@ Linux 有[上百个不同的发行版](https://distrowatch.com/)， 有经验的读者可以根据自己的喜好自行选择合适的 Linux 发行版。 对于不了解 Linux 的读者，**推荐使用 Fedora 或 Ubuntu 系统**，可以分别参考 -《{doc}`/computer/fedora-setup`》和《{doc}`/computer/ubuntu-setup`》 +《[](/computer/fedora-setup)》和《[](/computer/ubuntu-setup)》 来安装和配置系统，以满足科研工作的需求。 ## macOS @@ -36,7 +36,7 @@ Linux 有[上百个不同的发行版](https://distrowatch.com/)， Mac 笔记本（MacBook Air、MacBook Pro）或台式机（iMac、Mac mini、Mac Pro）自带的 macOS 系统可以满足科研工作的大部分需求。 **对于以 Mac 笔记本或 Mac 台式机作为科研主力机器的读者，建议直接使用 macOS 系统**。 -可以参考《{doc}`/computer/macos-setup`》对 macOS 系统进行配置，以满足科研工作的需求。 +可以参考《[](/computer/macos-setup)》对 macOS 系统进行配置，以满足科研工作的需求。 ## Microsoft Windows @@ -56,4 +56,4 @@ WSL 是微软官方开发的一个在 Windows 10/11 上运行原生 Linux 二进 与安装双系统相比，WSL 安装简便且可以在多系统之间无缝切换。 与使用虚拟机相比，WSL 在启动速度、消耗资源以及性能利用上有较大优势。 因此，对于绝大多数 Windows 10/11 用户，WSL 是比双系统和虚拟机更好的选择。 -可以参考《{doc}`/computer/wsl-setup`》来安装并配置 WSL，以满足科研工作的需求。 +可以参考《[](/computer/wsl-setup)》来安装并配置 WSL，以满足科研工作的需求。 diff --git a/source/computer/ubuntu-setup.md b/source/computer/ubuntu-setup.md index 8c5407a59..449ada05e 100644 --- a/source/computer/ubuntu-setup.md +++ b/source/computer/ubuntu-setup.md @@ -144,7 +144,7 @@ Ubuntu 会弹出提醒通知。建议用户及时更新系统及安装的软件 :::{warning} 更新系统前，特别是大版本更新（如 Ubuntu 20.04 更新为 Ubuntu 20.10）， -最好先进行一次备份（可以参考{doc}`/best-practices/backup`）。 +最好先进行一次备份（可以参考[](/best-practices/backup)）。 ::: :::{note} diff --git a/source/computer/wsl-setup.md b/source/computer/wsl-setup.md index 0c79f59dc..c3669dafe 100644 --- a/source/computer/wsl-setup.md +++ b/source/computer/wsl-setup.md @@ -81,8 +81,8 @@ $ bash ``` 通过 WSL 安装 Linux 系统后，还需要对 Linux 系统进行配置。 -Ubuntu 和 Fedora 用户可以分别参考《{doc}`/computer/ubuntu-setup`》和 -《{doc}`/computer/fedora-setup`》对系统进行配置，以满足科研工作的需求。 +Ubuntu 和 Fedora 用户可以分别参考《[](/computer/ubuntu-setup)》和 +《[](/computer/fedora-setup)》对系统进行配置，以满足科研工作的需求。 :::{warning} 配置 Linux 系统时，切记要跳过“安装系统”一节，只需配置**系统软件**和**编程开发环境**。 diff --git a/source/exercises/download.md b/source/exercises/download.md index fbfddb27e..0e0e91c91 100644 --- a/source/exercises/download.md +++ b/source/exercises/download.md @@ -4,6 +4,6 @@ 地震学数据主要分为三大类： -- {doc}`地震事件目录 ` -- {doc}`台站元信息及仪器响应 ` -- {doc}`地震波形数据 ` +- [地震事件目录](/exercises/catalog) +- [台站元信息及仪器响应](/exercises/station) +- [地震波形数据](/exercises/waveform) diff --git a/source/exercises/prerequisite.md b/source/exercises/prerequisite.md index 7baa2d1c9..257391a10 100644 --- a/source/exercises/prerequisite.md +++ b/source/exercises/prerequisite.md @@ -22,7 +22,7 @@ kernelspec: 这一章，我们将使用 Python 语言和 [ObsPy 软件包](https://docs.obspy.org/) 学习并掌握地震学数据的获取、处理和分析。在开始本章内容之前，读者应： -- 阅读《{doc}`/programming/python`》一节，并安装 Miniconda +- 阅读《[](/programming/python)》一节，并安装 Miniconda - 掌握 Python 的基本语法并了解如何执行 Python 代码 ## 安装依赖包 diff --git a/source/exercises/software.md b/source/exercises/software.md index 59cc55b7b..4927658e9 100644 --- a/source/exercises/software.md +++ b/source/exercises/software.md @@ -11,7 +11,7 @@ :::{note} 阅读本教程时，推荐地震学新手先参考以下中文教程中的安装部分在计算机上安装这些软件。 -《{doc}`地震学实践 `》这一章则会通过简单实例展示一些基本用法。 +《[地震学实践](/exercises/intro)》这一章则会通过简单实例展示一些基本用法。 阅读完本教程后，再详细阅读各软件的中文和官方教程。 一般而言，只需阅读中文教程中的入门教程，即可入门和开展科研工作。 diff --git a/source/programming/bash.md b/source/programming/bash.md index 882f3b72b..65b0967c3 100644 --- a/source/programming/bash.md +++ b/source/programming/bash.md @@ -18,7 +18,7 @@ GNU bash，version 5.0.3(1)-release (x86_64-pc-linux-gnu) ``` 这一节中，我们不介绍具体的 Bash 语法，而是介绍如何编写和执行 Bash 脚本。 -{doc}`/computer/linux101` 一节中已经简要介绍了 Bash 语法， +[](/computer/linux101) 一节中已经简要介绍了 Bash 语法， 本节的最后也列出了一些 Bash 学习资源，读者可根据需要自行学习。 ## Bash 脚本 @@ -94,7 +94,7 @@ Hello world! This is seismo-learn. 拥有 Shebang 行和可执行权限的脚本，在调用时还需要指定脚本的路径， 如 `./hello-world.sh` 代表该脚本位于当前目录。如果将脚本放在环境变量 **PATH** 指定的目录中，就不需要指定路径了，因为 Bash 会自动到这些目录中寻找是否存在同名的 -可执行文件。可以参考{doc}`/computer/environment-variable`一节 +可执行文件。可以参考[](/computer/environment-variable) 一节 设置环境变量 **PATH**。 ## 扩展阅读 diff --git a/source/programming/editor.md b/source/programming/editor.md index fcd952e6c..bdf0d456f 100644 --- a/source/programming/editor.md +++ b/source/programming/editor.md @@ -25,4 +25,4 @@ VS Code 下载地址： ## 使用 VS Code 建议在日常科研中随时根据个人习惯，去配置 VS Code、安装和使用扩展包等。 -更多的配置和使用技巧见 {doc}`/best-practices/vscode`。 +更多的配置和使用技巧见 [](/best-practices/vscode)。 diff --git a/source/programming/python.md b/source/programming/python.md index 78dcf6975..c73f174c1 100644 --- a/source/programming/python.md +++ b/source/programming/python.md @@ -54,7 +54,7 @@ Miniconda ::: 下面展示了如何在 Linux 系统下安装 Miniconda。其它操作系统下的安装说明以及具体使用方法可以参考 -{doc}`地震“学”软件中 Anaconda 相关内容 `。 +[地震“学”软件中 Anaconda 相关内容](inv:software:anaconda/index)。 1. 下载 Miniconda diff --git a/source/seismology/seismic-phase.md b/source/seismology/seismic-phase.md index 18a97d68a..034319a39 100644 --- a/source/seismology/seismic-phase.md +++ b/source/seismology/seismic-phase.md @@ -94,7 +94,7 @@ ```{note} 除了上图展示的全球尺度的震相外，在小震中距范围内沿地壳、上地幔传播的地震震相更为复杂， 且部分震相的命名并未统一。因此，本教程不做介绍，读者可以参考 -{doc}`seis:ray-nomenclature/crustal-phases`学习相关震相定义。 +[](inv:seis:ray-nomenclature/crustal-phases) 学习相关震相定义。 ``` 我们以地震与台站之间的距离为 X 轴，以台站观测到的地震震相走时为 Y 轴，将全球地震的震相走时