From e015cf9d0e6da338b4cbbf3a8efe406b72f7390f Mon Sep 17 00:00:00 2001 From: BO ZHANG Date: Sun, 11 Sep 2022 13:37:15 +0800 Subject: [PATCH] use English titles --- doc/source/codestyle.rst | 4 ++-- doc/source/git.rst | 16 ++++++++-------- doc/source/index.rst | 4 ++-- doc/source/unittest.rst | 6 +++--- 4 files changed, 15 insertions(+), 15 deletions(-) diff --git a/doc/source/codestyle.rst b/doc/source/codestyle.rst index 9abae83..24676ac 100644 --- a/doc/source/codestyle.rst +++ b/doc/source/codestyle.rst @@ -11,8 +11,8 @@ More specifically, Numpydoc style, conf https://numpydoc.readthedocs.io/en/latest/format.html -标记语言 -======= +Markup language +=============== 标记语言(Markup language) 可以分为三类 diff --git a/doc/source/git.rst b/doc/source/git.rst index f818035..d8e6ee8 100644 --- a/doc/source/git.rst +++ b/doc/source/git.rst @@ -1,5 +1,5 @@ -为什么需要版本控制 -=============== +Why version control? +==================== 版本控制有两个最重要的好处,即 @@ -27,19 +27,19 @@ - 参考书《Pro Git (2nd Edition)》:https://git-scm.com/book/en/v2 -`git` 的基本使用 -=============== +Basic usages +============ -如何建库 -------- +Create a new project/repository +------------------------------- 在gitlab或者github页面中点击 `New Project` 即可在自己的账户下或者拥有权限的组织中新建代码库(repository)。 -克隆远程代码库到本地 +Clone remote code ----------------- -CSST gitlab +CSST GitLab =========== CSST 项目利用国家天文台的服务器提供了GitLab服务,网址为 https://csst-tb.bao.ac.cn/code/。 diff --git a/doc/source/index.rst b/doc/source/index.rst index ef0a1db..a3e44a1 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -3,8 +3,8 @@ You can adapt this file completely to your liking, but it should at least contain the root `toctree` directive. -CSST一级流水线原型 -================ +CSST pipeline prototype +======================= .. meta:: :description lang=cn: Automate building, versioning, and hosting of your technical documentation continuously on Read the Docs. diff --git a/doc/source/unittest.rst b/doc/source/unittest.rst index 9dbffba..b54e575 100644 --- a/doc/source/unittest.rst +++ b/doc/source/unittest.rst @@ -1,5 +1,5 @@ -单元测试相关的pacakge -=================== +Useful packages +=============== use @@ -9,7 +9,7 @@ use - `coverage` -gitlab CI/CD pipeline +GitLab CI/CD pipeline ===================== 自动化流水线。 -- GitLab