Add Simplified Chinese (abbr. zh) Translation (#89)

* [cn-zh] add intro.rst * [cn-zh] add about_author.rst * [cn-zh] add frequency_domain.rst * added chinese version to makefile and build pipeline * [cn-zh] update Makefile for book title translation * [cn-zh] add iq_files.rst * [cn-zh] add sampling.rst * [cn-zh] final polishing --------- Co-authored-by: Marc Lichtman <[email protected]>
777arc · Jan 8, 2024 · 3d9fd32 · 3d9fd32
1 parent 7fc1655
commit 3d9fd32
Show file tree

Hide file tree

Showing 11 changed files with 1,741 additions and 4 deletions.
diff --git a/.github/workflows/build-and-deploy.yml b/.github/workflows/build-and-deploy.yml
@@ -72,6 +72,11 @@ jobs:
         env:
           CREATOR_ID: ${{ secrets.CREATOR_ID }}
 
+      - name: Build Chinese
+        run: make html-zh
+        env:
+          CREATOR_ID: ${{ secrets.CREATOR_ID }}
+
       - name: Upload artifact
         uses: actions/upload-pages-artifact@v2
         with:

diff --git a/Makefile b/Makefile
@@ -67,22 +67,28 @@ html:
 #make sure you install sphinxcontrib-tikz python module and pdf2svg application
 .PHONY: html-nl
 html-nl:
-	$(SPHINXBUILD) -b html -D project="PySDR: Een handleiding voor SDR en DSP met Python" -D exclude_patterns=_build,index.rst,content/*,index-fr.rst,content-fr/*,index-ukraine.rst,content-ukraine/* -D master_doc=index-nl $(EXTENSIONS) . $(BUILDDIR)/nl/
+	$(SPHINXBUILD) -b html -D project="PySDR: Een handleiding voor SDR en DSP met Python" -D exclude_patterns=_build,index.rst,content/*,index-fr.rst,content-fr/*,index-ukraine.rst,content-ukraine/*,index-zh.rst,content-zh/* -D master_doc=index-nl $(EXTENSIONS) . $(BUILDDIR)/nl/
 	@echo
 	@echo "Dutch Build finished. The HTML pages are in $(BUILDDIR)/nl/html."
 
 .PHONY: html-fr
 html-fr:
-	$(SPHINXBUILD) -b html -D project="PySDR : un guide sur SDR et DSP à l'aide de Python" -D exclude_patterns=_build,index.rst,content/*,index-nl.rst,content-nl/*,index-ukraine.rst,content-ukraine/* -D master_doc=index-fr $(EXTENSIONS) . $(BUILDDIR)/fr/
+	$(SPHINXBUILD) -b html -D project="PySDR : un guide sur SDR et DSP à l'aide de Python" -D exclude_patterns=_build,index.rst,content/*,index-nl.rst,content-nl/*,index-ukraine.rst,content-ukraine/*,index-zh.rst,content-zh/* -D master_doc=index-fr $(EXTENSIONS) . $(BUILDDIR)/fr/
 	@echo
 	@echo "French Build finished. The HTML pages are in $(BUILDDIR)/fr/html."
 
 .PHONY: html-ukraine
 html-ukraine:
-	$(SPHINXBUILD) -b html -D project="PySDR: Посібник з SDR та DSP за допомогою Python" -D exclude_patterns=_build,index.rst,content/*,index-fr.rst,content-fr/*,index-nl.rst,content-nl/* -D master_doc=index-ukraine $(EXTENSIONS) . $(BUILDDIR)/ukraine/
+	$(SPHINXBUILD) -b html -D project="PySDR: Посібник з SDR та DSP за допомогою Python" -D exclude_patterns=_build,index.rst,content/*,index-fr.rst,content-fr/*,index-nl.rst,content-nl/*,index-zh.rst,content-zh/* -D master_doc=index-ukraine $(EXTENSIONS) . $(BUILDDIR)/ukraine/
 	@echo
 	@echo "Build finished. The HTML pages are in $(BUILDDIR)/ukraine/html."
 
+.PHONY: html-zh
+html-zh:
+	$(SPHINXBUILD) -b html -D project="PySDR：使用 Python 玩转 SDR 和 DSP" -D exclude_patterns=_build,index.rst,content/*,index-fr.rst,content-fr/*,index-nl.rst,content-nl/*,index-ukraine.rst,content-ukraine/* -D master_doc=index-zh $(EXTENSIONS) . $(BUILDDIR)/zh/
+	@echo
+	@echo "Build finished. The HTML pages are in $(BUILDDIR)/zh/html."
+
 .PHONY: dirhtml
 dirhtml:
 	$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml

diff --git a/_static/cn.svg b/_static/cn.svg
diff --git a/_templates/layout.html b/_templates/layout.html
@@ -65,5 +65,6 @@
   <img src="https://pysdr.org/_static/nl.svg" alt="Dutch Version" width="20"><a href="https://pysdr.org/nl/index-nl.html">Dutch</a>&nbsp;&nbsp;
   <img src="https://pysdr.org/_static/fr.svg" alt="French Version" width="20"><a href="https://pysdr.org/fr/index-fr.html">French</a>&nbsp;&nbsp;
   <img src="https://pysdr.org/_static/ukrain.svg" alt="Ukrainian Version" width="20"><a href="https://pysdr.org/ukraine/index-ukraine.html">Ukrainian</a>
+  <img src="https://pysdr.org/_static/cn.svg" alt="Chinese Version" width="20"><a href="https://pysdr.org/zh/index-zh.html">Chinese</a>
 </div>
 {% endblock %}
diff --git a/conf.py b/conf.py
@@ -125,7 +125,7 @@
 
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.
-exclude_patterns = ['_build', 'index-fr.rst', 'content-fr/*', 'index-nl.rst', 'content-nl/*', 'index-ukraine.rst', 'content-ukraine/*']
+exclude_patterns = ['_build', 'index-fr.rst', 'content-fr/*', 'index-nl.rst', 'content-nl/*', 'index-ukraine.rst', 'content-ukraine/*', 'index-zh.rst', 'content-zh/*']
 
 # The reST default role (used for this markup: `text`) to use for all
 # documents.

diff --git a/content-zh/about_author.rst b/content-zh/about_author.rst
@@ -0,0 +1,28 @@
+.. _author-chapter:
+
+##################
+关于作者
+##################
+
+马克·利希特曼（Marc Lichtman）博士是无线通信领域的研究员，
+专长于 SDR（软件定义无线电），机器学习，LTE/5G-NR，以及频谱感知。
+他是马里兰大学的兼职教授，在那里他创立了一门课程，该课程成为了他编写这本教科书的基础。
+他的课程是一个面向对 SDR/DSP（数字信号处理）感兴趣的计算机科学本科生的四年级选修课。
+这门课程使他更好地了解了如何深入浅出地吸引并教会那些编程能力很强但几乎不了解物理层知识的学生。
+在马克的课程中遇到迷你黑客马拉松并不奇怪，学生们必须利用他们最近学到的知识来找到或解码（由 Marc 发送）的隐藏的信号。
+
+Marc 也是 `GNU Radio项目 <https://www.gnuradio.org/>`_ 的主要负责人之一。
+GNU Radio 是一个开源的 SDR 框架，在学术界和国防相关研究中被广泛应用。
+虽然 Python 非常适合学习、快速实验和开发，但它并不适合大型和计算复杂的应用程序。
+GNU Radio 能够实现更高级的 DSP 应用程序，而且使用 GNU Radio 开发的 App 或单独的 Block 非常容易与他人共享。
+
+Marc 目前和他的妻子 Lindsey 以及他们的多只猫和狗一起住在华盛顿特区地区。
+他的爱好包括木工制作、激光切割、演奏单簧管/萨克斯风、帆船、园艺、制作/操纵无人机、制作/骑行电动滑板，以及钻研高级溜溜球技巧。
+
+邮箱: [email protected]
+
+马里兰大学的教职页面: `cs.umd.edu/people/sdr <https://www.cs.umd.edu/people/sdr>`_
+
+.. image:: ../_images/silly_marc.jpg
+   :scale: 100 %
+   :align: center