add English doc support. #56

.gitignore

@@ -12,4 +12,5 @@
 core/src/main/resources/com/taobao/arthas/core/res/version
 **/*.orig
 
-site/src/site/sphinx/_build
+site/src/site/sphinx/_build
+site/src/site/sphinx/en/_build

site/pom.xml

@@ -18,14 +18,28 @@
                         <groupId>kr.motd.maven</groupId>
                         <artifactId>sphinx-maven-plugin</artifactId>
                         <version>2.2.3</version>
-                        <configuration>
-                            <asReport>true</asReport>
-                            <name>Project documentation</name>
-                            <description>Documentation about Arthas</description>
-                        </configuration>
                         <executions>
                             <execution>
+                                <id>zh doc</id>
                                 <phase>package</phase>
+                                <configuration>
+                                    <asReport>true</asReport>
+                                    <name>Arthas documentation</name>
+                                    <description>Documentation about Arthas</description>
+                                </configuration>
+                                <goals>
+                                    <goal>generate</goal>
+                                </goals>
+                            </execution>
+                            <execution>
+                                <id>en doc</id>
+                                <phase>package</phase>
+                                <configuration>
+                                    <asReport>true</asReport>
+                                    <sourceDirectory>${basedir}/src/site/sphinx/en</sourceDirectory>
+                                    <name>Arthas English documentation</name>
+                                    <description>Documentation about Arthas</description>
+                                </configuration>
                                 <goals>
                                     <goal>generate</goal>
                                 </goals>
@@ -35,7 +49,6 @@
                 </plugins>
             </build>
         </profile>
-
     </profiles>
 
 </project>

site/src/site/sphinx/en/Makefile

@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+SPHINXOPTS    =
+SPHINXBUILD   = sphinx-build
+SPHINXPROJ    = arthas
+SOURCEDIR     = .
+BUILDDIR      = _build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

site/src/site/sphinx/en/_static

@@ -0,0 +1 @@
+../_static/

site/src/site/sphinx/en/_templates

@@ -0,0 +1 @@
+../_templates/

site/src/site/sphinx/en/arthas.png

@@ -0,0 +1 @@
+../arthas.png

site/src/site/sphinx/en/conf.py

@@ -0,0 +1,302 @@
+# -*- coding: utf-8 -*-
+#
+# Arthas documentation build configuration file
+#
+
+
+import sys
+import os
+import shlex
+import xml.etree.ElementTree as ET
+
+# If extensions (or modules to document with autodoc) are in another directory,
+# add these directories to sys.path here. If the directory is relative to the
+# documentation root, use os.path.abspath to make it absolute, like shown here.
+sys.path.insert(0, os.path.abspath('..'))
+import recommonmark
+from recommonmark.parser import CommonMarkParser
+from recommonmark.transform import AutoStructify
+
+source_parsers = {
+    '.md': CommonMarkParser
+}
+
+source_suffix = ['.rst', '.md']
+
+# -- General configuration ------------------------------------------------
+
+# If your documentation needs a minimal Sphinx version, state it here.
+#needs_sphinx = '1.0'
+
+# Add any Sphinx extension module names here, as strings. They can be
+# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
+# ones.
+extensions = [
+    'sphinx.ext.autodoc',
+    'sphinx.ext.napoleon',
+    'sphinx.ext.mathjax',
+    'sphinx_markdown_tables',
+]
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['_templates']
+
+# The encoding of source files.
+#source_encoding = 'utf-8-sig'
+
+# The master toctree document.
+master_doc = 'index'
+
+# General information about the project.
+project = u'Arthas'
+copyright = u'2018, Alibaba Middleware Group, and contributors'
+author = u'Alibaba Middleware Group, and contributors'
+
+github_doc_root = 'https://github.com/alibaba/arthas/tree/master/site/src/site/sphinx/en'
+
+# The version info for the project you're documenting, acts as replacement for
+# |version| and |release|, also used in various other places throughout the
+# built documents.
+#
+# The short X.Y version.
+# version = 
+# The full version, including alpha/beta/rc tagss
+# release = 
+# read version from pom.xml
+rootDir = os.path.dirname(os.path.abspath(__file__)) + '/../../../..'
+pomXml = ET.parse(rootDir + '/pom.xml')
+
+for projectChildrenElem in list(pomXml.getroot()):
+  if projectChildrenElem.tag == '{http://maven.apache.org/POM/4.0.0}parent':
+    for parentChildrenElem in list(projectChildrenElem):
+      if parentChildrenElem.tag == '{http://maven.apache.org/POM/4.0.0}version':
+        version = parentChildrenElem.text
+release = version
+
+# The language for content autogenerated by Sphinx. Refer to documentation
+# for a list of supported languages.
+#
+# This is also used if you do content translation via gettext catalogs.
+# Usually you set "language" from the command line for these cases.
+# language = u'zh_CN'
+
+# There are two options for replacing |today|: either, you set today to some
+# non-false value, then it is used:
+#today = ''
+# Else, today_fmt is used as the format for a strftime call.
+#today_fmt = '%B %d, %Y'
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+exclude_patterns = [u'_build', 'Thumbs.db', '.DS_Store']
+
+# The reST default role (used for this markup: `text`) to use for all
+# documents.
+#default_role = None
+
+# If true, '()' will be appended to :func: etc. cross-reference text.
+#add_function_parentheses = True
+
+# If true, the current module name will be prepended to all description
+# unit titles (such as .. function::).
+#add_module_names = True
+
+# If true, sectionauthor and moduleauthor directives will be shown in the
+# output. They are ignored by default.
+#show_authors = False
+
+# The name of the Pygments (syntax highlighting) style to use.
+pygments_style = 'sphinx'
+
+# A list of ignored prefixes for module index sorting.
+#modindex_common_prefix = []
+
+# If true, keep warnings as "system message" paragraphs in the built documents.
+#keep_warnings = False
+
+# 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
+# a list of builtin themes.
+html_theme = 'sphinx_rtd_theme'
+
+# Theme options are theme-specific and customize the look and feel of a theme
+# further.  For a list of options available for each theme, see the
+# documentation.
+#html_theme_options = {}
+
+# Add any paths that contain custom themes here, relative to this directory.
+#html_theme_path = []
+
+# The name for this set of Sphinx documents.  If None, it defaults to
+# "<project> v<release> documentation".
+#html_title = None
+
+# A shorter title for the navigation bar.  Default is the same as html_title.
+#html_short_title = None
+
+# The name of an image file (relative to this directory) to place at the top
+# of the sidebar.
+#html_logo = None
+
+# The name of an image file (within the static path) to use as favicon of the
+# docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
+# pixels large.
+html_favicon = "favicon.ico"
+
+# Add any paths that contain custom static files (such as style sheets) here,
+# relative to this directory. They are copied after the builtin static files,
+# so a file named "default.css" will overwrite the builtin "default.css".
+html_static_path = ['_static']
+
+# Add any extra paths that contain custom files (such as robots.txt or
+# .htaccess) here, relative to this directory. These files are copied
+# directly to the root of the documentation.
+#html_extra_path = []
+
+# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
+# using the given strftime format.
+#html_last_updated_fmt = '%b %d, %Y'
+
+# If true, SmartyPants will be used to convert quotes and dashes to
+# typographically correct entities.
+#html_use_smartypants = True
+
+# Custom sidebar templates, maps document names to template names.
+#html_sidebars = {}
+
+# Additional templates that should be rendered to pages, maps page names to
+# template names.
+#html_additional_pages = {}
+
+# If false, no module index is generated.
+#html_domain_indices = True
+
+# If false, no index is generated.
+#html_use_index = True
+
+# If true, the index is split into individual pages for each letter.
+#html_split_index = False
+
+# If true, links to the reST sources are added to the pages.
+#html_show_sourcelink = True
+
+# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
+#html_show_sphinx = True
+
+# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
+#html_show_copyright = True
+
+# If true, an OpenSearch description file will be output, and all pages will
+# contain a <link> tag referring to it.  The value of this option must be the
+# base URL from which the finished HTML is served.
+#html_use_opensearch = ''
+
+# This is the file name suffix for HTML files (e.g. ".xhtml").
+#html_file_suffix = None
+
+# Language to be used for generating the HTML full-text search index.
+# Sphinx supports the following languages:
+#   'da', 'de', 'en', 'es', 'fi', 'fr', 'hu', 'it', 'ja'
+#   'nl', 'no', 'pt', 'ro', 'ru', 'sv', 'tr'
+#html_search_language = 'en'
+
+# A dictionary with options for the search language support, empty by default.
+# Now only 'ja' uses this config value
+#html_search_options = {'type': 'default'}
+
+# The name of a javascript file (relative to the configuration directory) that
+# implements a search results scorer. If empty, the default will be used.
+#html_search_scorer = 'scorer.js'
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = 'Arthas'
+
+# -- Options for LaTeX output ---------------------------------------------
+
+latex_elements = {
+# The paper size ('letterpaper' or 'a4paper').
+#'papersize': 'letterpaper',
+
+# The font size ('10pt', '11pt' or '12pt').
+#'pointsize': '10pt',
+
+# Additional stuff for the LaTeX preamble.
+#'preamble': '',
+
+# Latex figure (float) alignment
+#'figure_align': 'htbp',
+}
+
+
+# The name of an image file (relative to this directory) to place at the top of
+# the title page.
+#latex_logo = None
+
+# For "manual" documents, if this is true, then toplevel headings are parts,
+# not chapters.
+#latex_use_parts = False
+
+# If true, show page references after internal links.
+#latex_show_pagerefs = False
+
+# If true, show URL addresses after external links.
+#latex_show_urls = False
+
+# Documents to append as an appendix to all manuals.
+#latex_appendices = []
+
+# If false, no module index is generated.
+#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, 'arthas', u'Arthas 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, 'Arthas', u'Arthas Documentation',
+   author, 'Arthas', 'One line description of project.',
+   'Miscellaneous'),
+]
+
+# Documents to append as an appendix to all manuals.
+#texinfo_appendices = []
+
+# If false, no module index is generated.
+#texinfo_domain_indices = True
+
+# How to display URL addresses: 'footnote', 'no', or 'inline'.
+#texinfo_show_urls = 'footnote'
+
+# If true, do not generate a @detailmenu in the "Top" node's menu.
+#texinfo_no_detailmenu = False
+
+# app setup hook
+def setup(app):
+    app.add_config_value('recommonmark_config', {
+        'url_resolver': lambda url: github_doc_root + url,
+        # 'auto_toc_tree_section': 'Contents',
+        'enable_eval_rst': True,
+        # 'enable_auto_doc_ref': True,
+        'enable_auto_toc_tree': True,
+    }, True)
+    app.add_transform(AutoStructify)

site/src/site/sphinx/en/favicon.ico

@@ -0,0 +1 @@
+../favicon.ico

site/src/site/sphinx/en/index.md

@@ -0,0 +1,36 @@
+Arthas Documentation
+===
+
+## Arthas（阿尔萨斯） 能为你做什么？
+
+![arthas](arthas.png)
+
+`Arthas` 是Alibaba开源的Java诊断工具，深受开发者喜爱。
+
+当你遇到以下类似问题而束手无策时，`Arthas`可以帮助你解决：
+
+0. 这个类从哪个 jar 包加载的？为什么会报各种类相关的 Exception？
+0. 我改的代码为什么没有执行到？难道是我没 commit？分支搞错了？
+0. 遇到问题无法在线上 debug，难道只能通过加日志再重新发布吗？
+0. 线上遇到某个用户的数据处理有问题，但线上同样无法 debug，线下无法重现！
+0. 是否有一个全局视角来查看系统的运行状况？
+0. 有什么办法可以监控到JVM的实时运行状态？
+
+`Arthas`采用命令行交互模式，同时提供丰富的 `Tab` 自动补全功能，进一步方便进行问题的定位和诊断。
+
+
+Contents
+--------
+
+* [安装](install-detail.md)
+* [快速入门](quick-start.md)
+* [进阶使用](advanced-use.md)
+* [命令列表](commands.md)
+* [用户案例](https://github.com/alibaba/arthas/labels/user-case)
+* [Release Notes](release-notes.md)
+* [Questions and answers](https://github.com/alibaba/arthas/labels/question-answered)
+* [Fork me at GitHub](https://github.com/alibaba/arthas)
+* [参与贡献](https://github.com/alibaba/arthas/blob/master/CONTRIBUTING.md)
+
+
+

site/src/site/sphinx/en/make.bat

@@ -0,0 +1,36 @@
+@ECHO OFF
+
+pushd %~dp0
+
+REM Command file for Sphinx documentation
+
+if "%SPHINXBUILD%" == "" (
+	set SPHINXBUILD=sphinx-build
+)
+set SOURCEDIR=.
+set BUILDDIR=_build
+set SPHINXPROJ=arthas
+
+if "%1" == "" goto help
+
+%SPHINXBUILD% >NUL 2>NUL
+if errorlevel 9009 (
+	echo.
+	echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
+	echo.installed, then set the SPHINXBUILD environment variable to point
+	echo.to the full path of the 'sphinx-build' executable. Alternatively you
+	echo.may add the Sphinx directory to PATH.
+	echo.
+	echo.If you don't have Sphinx installed, grab it from
+	echo.http://sphinx-doc.org/
+	exit /b 1
+)
+
+%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS%
+goto end
+
+:help
+%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS%
+
+:end
+popd