From 5c4030e75fdb4995f4350b3c0364f8d9f1bed024 Mon Sep 17 00:00:00 2001 From: wikinee Date: Wed, 29 Jul 2020 14:31:44 +0800 Subject: [PATCH] Add manually generate PDF documents guideline Add Javascript guide contents.rst --- conf.py | 8 ++++---- contents.rst | 1 + google-javascript-styleguide/contents.rst | 13 +++++++++++++ .../javascript_language_rules.rst | 6 +++--- .../javascript_style_rules.rst | 4 ++-- manually-generate-pdf-document.md | 9 +++++++++ 6 files changed, 32 insertions(+), 9 deletions(-) create mode 100644 google-javascript-styleguide/contents.rst create mode 100644 manually-generate-pdf-document.md diff --git a/conf.py b/conf.py index 648f54b..24b249f 100644 --- a/conf.py +++ b/conf.py @@ -12,7 +12,7 @@ source_suffix = '.rst' master_doc = 'contents' language = 'en_US' exclude_patterns = ['_build'] -extensions = ['sphinx.ext.pngmath'] +extensions = ['sphinx.ext.imgmath'] pygments_style = 'sphinx' # on_rtd is whether we are on readthedocs.org @@ -27,8 +27,8 @@ if not on_rtd: # only import and set the theme if we're building docs locally # otherwise, readthedocs.org uses their theme by default, so no need to specify it html_title = u'Google 开源项目风格指南' -htmlhelp_basename = 'google-styleguide' -html_add_permalinks = None +htmlhelp_basename = 'zh-google-styleguide' +html_add_permalinks = '' latex_engine = 'xelatex' file_insertion_enabled = False @@ -65,7 +65,7 @@ else: 'preamble' : r''' \usepackage{ctex} ''', } latex_documents = [ - ('contents', 'google-styleguide.tex', u'Google 开源项目风格指南', + ('contents', 'zh-google-styleguide.tex', u'Google 开源项目风格指南', u'', 'manual'), ] diff --git a/contents.rst b/contents.rst index b268cb2..7c4c3c7 100644 --- a/contents.rst +++ b/contents.rst @@ -12,3 +12,4 @@ google-objc-styleguide/contents google-python-styleguide/contents google-shell-styleguide/contents + google-javascript-styleguide/contents diff --git a/google-javascript-styleguide/contents.rst b/google-javascript-styleguide/contents.rst new file mode 100644 index 0000000..0e8643a --- /dev/null +++ b/google-javascript-styleguide/contents.rst @@ -0,0 +1,13 @@ +.. 请确保至少包含基本的 `toctree` 指令. + +.. _javascript_contents: + +Javascript 风格指南 - 内容目录 +========================== + +.. toctree:: + + index + background + javascript_language_rules.rst + javascript_style_rules.rst diff --git a/google-javascript-styleguide/javascript_language_rules.rst b/google-javascript-styleguide/javascript_language_rules.rst index 92675fd..8156556 100644 --- a/google-javascript-styleguide/javascript_language_rules.rst +++ b/google-javascript-styleguide/javascript_language_rules.rst @@ -1,5 +1,5 @@ -Javascript语言规则 -========== +Javascript语言规范 +===================== var关键字 ---------------- @@ -116,7 +116,7 @@ js语句要求以分号结尾,除非能够正确地推断分号的位置。在 这个错误让人震惊,所以一定要确保用分号结束语句。 澄清:分号和函数 -~~~~~~~~~~~~~~ +~~~~~~~~~~~~~~~~~~~ 函数表达式后面要分号结束,但是函数声明就不需要。例如: diff --git a/google-javascript-styleguide/javascript_style_rules.rst b/google-javascript-styleguide/javascript_style_rules.rst index dd6d870..5631a04 100644 --- a/google-javascript-styleguide/javascript_style_rules.rst +++ b/google-javascript-styleguide/javascript_style_rules.rst @@ -1,5 +1,5 @@ -Javascript格式规则 -================== +Javascript风格规范 +===================== 命名 -------------- diff --git a/manually-generate-pdf-document.md b/manually-generate-pdf-document.md new file mode 100644 index 0000000..cc21e22 --- /dev/null +++ b/manually-generate-pdf-document.md @@ -0,0 +1,9 @@ +Manually generate PDF documents +------- + +# Debian 9 +sudo apt install texlive-lang-chinese texlive-lang-cjk texlive-xetex xelatex \ +latexmk texlive-latex-extra texlive-latex-recommended latexpdf + +# pip version2 +sudo pip Sphinx commonmark sphinx-rtd-theme \ No newline at end of file