Merge pull request #501 from nudles/SINGA-480

Singa 480 Update documentations
apache · Aug 10, 2019 · 806dbe7 · 806dbe7
2 parents 6d1f90e + 7a6330e
commit 806dbe7
Show file tree

Hide file tree

Showing 24 changed files with 754 additions and 623 deletions.
diff --git a/.gitignore b/.gitignore
@@ -13,3 +13,4 @@ thirdparty/*
 !thirdparty/install.sh
 test/samples/
 .idea
+doc/_build/*
diff --git a/CMakeLists.txt b/CMakeLists.txt
@@ -19,9 +19,9 @@
 CMAKE_MINIMUM_REQUIRED(VERSION 2.8)
 
 PROJECT(singa)
-SET(PACKAGE_VERSION "2.0.0")
+SET(PACKAGE_VERSION "2.1.0")
 SET(SINGA_MAJOR_VERSION 2)  # 0 -
-SET(SINGA_MINOR_VERSION 0)  # 0 - 9
+SET(SINGA_MINOR_VERSION 1)  # 0 - 9
 SET(SINGA_PATCH_VERSION 0)  # 0 - 99
 MATH(EXPR SINGA_VERSION "${SINGA_MAJOR_VERSION} * 1000 + ${SINGA_MINOR_VERSION} * 100 + ${SINGA_PATCH_VERSION}")
 

diff --git a/doc/README.md b/doc/README.md
diff --git a/doc/conf.py b/doc/conf.py
@@ -19,6 +19,10 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+# Directives for doing spell check only for python comments
+# cSpell:includeRegExp #.*
+# cSpell:includeRegExp ("""|''')[^]*
+
 # This file is execfile()d with the current directory set to its
 # containing dir.
 #
@@ -40,7 +44,6 @@
 sys.path.append(os.path.abspath('../python/'))
 sys.path.append(os.path.abspath('../build/python/'))
 
-
 # -- General configuration ------------------------------------------------
 from recommonmark.parser import CommonMarkParser
 
@@ -71,7 +74,7 @@
 # source_encoding = 'utf-8-sig'
 
 # The master toctree document.
-master_doc = 'index'
+master_doc = 'en/index'
 
 # General information about the project.
 project = u'incubator-singa'
@@ -139,7 +142,6 @@
 # If true, `todo` and `todoList` produce output, else they produce nothing.
 todo_include_todos = False
 
-
 # -- Options for HTML output ----------------------------------------------
 
 # The theme to use for HTML and HTML Help pages.  See the documentation for
@@ -168,7 +170,7 @@
 # The name of an image file (relative to this directory) to place at the top
 # of the sidebar.
 #
-html_logo = '/singa.png'
+html_logo = '_static/singa.png'
 
 # The name of an image file (relative to this directory) to use as a favicon of
 # the docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
@@ -264,21 +266,21 @@
 # -- Options for LaTeX output ---------------------------------------------
 
 latex_elements = {
-     # The paper size ('letterpaper' or 'a4paper').
-     #
-     # 'papersize': 'letterpaper',
+    # The paper size ('letterpaper' or 'a4paper').
+    #
+    # 'papersize': 'letterpaper',
 
-     # The font size ('10pt', '11pt' or '12pt').
-     #
-     # 'pointsize': '10pt',
+    # The font size ('10pt', '11pt' or '12pt').
+    #
+    # 'pointsize': '10pt',
 
-     # Additional stuff for the LaTeX preamble.
-     #
-     # 'preamble': '',
+    # Additional stuff for the LaTeX preamble.
+    #
+    # 'preamble': '',
 
-     # Latex figure (float) alignment
-     #
-     # 'figure_align': 'htbp',
+    # Latex figure (float) alignment
+    #
+    # 'figure_align': 'htbp',
 }
 
 # Grouping the document tree into LaTeX files. List of tuples
@@ -315,30 +317,25 @@
 #
 # latex_domain_indices = True
 
-
 # -- Options for manual page output ---------------------------------------
 
 # One entry per manual page. List of tuples
 # (source start file, name, description, authors, manual section).
-man_pages = [
-    (master_doc, 'incubator-singa', u'incubator-singa Documentation',
-     [author], 1)
-]
+man_pages = [(master_doc, 'incubator-singa', u'incubator-singa Documentation',
+              [author], 1)]
 
 # If true, show URL addresses after external links.
 #
 # man_show_urls = False
 
-
 # -- Options for Texinfo output -------------------------------------------
 
 # Grouping the document tree into Texinfo files. List of tuples
 # (source start file, target name, title, author,
 #  dir menu entry, description, category)
 texinfo_documents = [
-    (master_doc, 'incubator-singa', u'incubator-singa Documentation',
-     author, 'incubator-singa', 'One line description of project.',
-     'Miscellaneous'),
+    (master_doc, 'incubator-singa', u'incubator-singa Documentation', author,
+     'incubator-singa', 'One line description of project.', 'Miscellaneous'),
 ]
 
 # Documents to append as an appendix to all manuals.

diff --git a/doc/en/_templates/layout.html b/doc/en/_templates/layout.html
diff --git a/doc/en/community/team-list.rst b/doc/en/community/team-list.rst
@@ -46,11 +46,11 @@ The SINGA community has developers mainly from National University of Singapore,
 +--------------------+--------------------------------+-----------------------------------------------+
 | Haibo Chen         | [email protected]   | NetEase                                       |
 +--------------------+--------------------------------+-----------------------------------------------+
-| Anh Dinh           | [email protected]             | National University of Singapore              |
+| Anh Dinh           | [email protected]             | Singapore University of Technology and Design |
 +--------------------+--------------------------------+-----------------------------------------------+
-| Jinyang Gao        | [email protected]             | National University of Singapore              |
+| Jinyang Gao        | [email protected]             | DAMO Academy, Alibaba Group                   |
 +--------------------+--------------------------------+-----------------------------------------------+
-| Xin Ji             | [email protected]          | National University of Singapore              |
+| Xin Ji             | [email protected]          | Visenze                                       |
 +--------------------+--------------------------------+-----------------------------------------------+
 | Chonho Lee         | [email protected]               | Osaka University                              |
 +--------------------+--------------------------------+-----------------------------------------------+
@@ -62,23 +62,34 @@ The SINGA community has developers mainly from National University of Singapore,
 +--------------------+--------------------------------+-----------------------------------------------+
 | Anthony K. H. Tung | [email protected]          | National University of Singapore              |
 +--------------------+--------------------------------+-----------------------------------------------+
-| Ji Wang            | [email protected]         | National University of Singapore              |
+| Ji Wang            | [email protected]         | Hangzhou MZH Technologies                     |
 +--------------------+--------------------------------+-----------------------------------------------+
-| Sheng Wang         | [email protected]              | National University of Singapore              |
+| Sheng Wang         | [email protected]              | DAMO Academy, Alibaba Group                   |
 +--------------------+--------------------------------+-----------------------------------------------+
 | Wei Wang           | [email protected]             | National University of Singapore              |
 +--------------------+--------------------------------+-----------------------------------------------+
 | Yuan Wang          | [email protected]      | NetEase                                       |
 +--------------------+--------------------------------+-----------------------------------------------+
 | Wenfeng Wu         | [email protected]           | National University of Singapore              |
 +--------------------+--------------------------------+-----------------------------------------------+
-| Zhongle Xie        | [email protected]             | National University of Singapore              |
+| Zhongle Xie        | [email protected]             | Hangzhou MZH Technologies                     |
 +--------------------+--------------------------------+-----------------------------------------------+
-| Meihui Zhang       | [email protected]       | Singapore University of Technology and Design |
+| Meihui Zhang       | [email protected]       | Beijing Institute of Technology               |
 +--------------------+--------------------------------+-----------------------------------------------+
 | Kaiping Zheng      | [email protected]             | National University of Singapore              |
 +--------------------+--------------------------------+-----------------------------------------------+
 | Moaz Reyad         | [email protected]                | University of Genoa                           |
 +--------------------+--------------------------------+-----------------------------------------------+
-| Chang Yao          | [email protected]         | yzBigdata                                     |
+| Chang Yao          | [email protected]         | Hangzhou MZH Technologies                     |
 +--------------------+--------------------------------+-----------------------------------------------+
+
+
+
+How to become a SINGA committer
+--------------------------------
+
+SINGA committers are members that have write access to SINGA code and documentation repositories. They can contribute by themselves and accept other contributions.
+
+Becoming a SINGA committer requires understanding the Apache Way and being an active member in the SINGA project. An active member participates on mailing lists, answers questions, contributes code, tests and documentation, presents SINGA in talks and seminars, verifies releases and report issues or feature requests.
+
+New committers can be suggested by current committers or PPMC members, and voted upon by the PPMC according to Apache guidelines. You can start by talking to other committers and ask for their advice and guidance.