diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 07deba475..82a9d76d1 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -51,11 +51,10 @@ Tip: you can use `--versions` to list all available versions. * Arthas is using [Sphinx](http://www.sphinx-doc.org/en/master/) to generate the static site * `sphinx-maven-plugin` configured in [`site/pom.xml`](https://github.com/alibaba/arthas/tree/master/site) * `sphinx-maven-plugin` executes by downloading`sphinx-binary/` -* a [bug](https://github.com/rtfd/recommonmark/issues/93) in Sphinx plugin `recommonmark`; we fix it by packaging another [version](https://github.com/hengyunabc/sphinx-binary/releases/tag/v0.4.0.1) -* when packaging the whole project (Packaging All), you need to (Only Unix/Linux/Mac supported): +* when packaging the whole project (Packaging All), you need to execute: ```bash - ./mvnw clean package -DskipTests -P full -Dsphinx.binUrl=https://github.com/hengyunabc/sphinx-binary/releases/download/v0.4.0.1/sphinx.osx-x86_64 + ./mvnw clean package -DskipTests -P full ``` @@ -112,7 +111,7 @@ Tip: you can use `--versions` to list all available versions. * 在`site/pom.xml`里配置了`sphinx-maven-plugin` * `sphinx-maven-plugin`通过下载`sphinx-binary/`来执行 * sphinx配置的`recommonmark`插件有bug:https://github.com/rtfd/recommonmark/issues/93 ,因此另外打包了一个修复版本: https://github.com/hengyunabc/sphinx-binary/releases/tag/v0.4.0.1 -* 全量打包时,需要配置下面的参数(目前只支持mac/linux): +* 全量打包时,需要配置下面的参数: ``` ./mvnw clean package -DskipTests -P full -Dsphinx.binUrl=https://github.com/hengyunabc/sphinx-binary/releases/download/v0.4.0.1/sphinx.osx-x86_64 @@ -125,9 +124,9 @@ Tip: you can use `--versions` to list all available versions. * 修改`as.sh`里的版本 * 修改本地的maven settings.xml * mvn release:prepare -Darguments="-DskipTests" -* mvn release:perform -Darguments="-DskipTests -P full -Dsphinx.binUrl=https://github.com/hengyunabc/sphinx-binary/releases/download/v0.4.0.1/sphinx.osx-x86_64" +* mvn release:perform -Darguments="-DskipTests -P full - 如果在下载 https://github.com/hengyunabc/sphinx-binary/releases/download/v0.4.0.1/sphinx.osx-x86_64 时有问题,可以先下载到本地,然后用 `file:/tmp/sphinx.osx-x86_64` 的方式指定 + 如果在下载 https://github.com/trustin/sphinx-binary/releases/download/v0.7.1/sphinx.osx-x86_64 时有问题,可以先下载到本地,然后用 `file:/tmp/sphinx.osx-x86_64` 的方式指定 * 到 https://oss.sonatype.org/ 上,“Staging Repositories”然后close掉自己的,再release * 发布完maven仓库之后,需要到阿里云的仓库里检查是否同步,有可能有延时 diff --git a/site/pom.xml b/site/pom.xml index 0f98c0052..1065258e1 100644 --- a/site/pom.xml +++ b/site/pom.xml @@ -18,7 +18,7 @@ kr.motd.maven sphinx-maven-plugin - 2.2.3 + 2.6.0 zh doc diff --git a/site/src/site/sphinx/conf.py b/site/src/site/sphinx/conf.py index ec745f921..2f716a5e1 100644 --- a/site/src/site/sphinx/conf.py +++ b/site/src/site/sphinx/conf.py @@ -38,7 +38,7 @@ extensions = [ 'sphinx.ext.napoleon', 'sphinx.ext.mathjax', 'sphinx_markdown_tables', - 'sphinxcontrib.inlinesyntaxhighlight', +# 'sphinxcontrib.inlinesyntaxhighlight', 'highlightjs', ] @@ -305,12 +305,12 @@ texinfo_documents = [ #texinfo_no_detailmenu = False # sphinxcontrib-inlinesyntaxhighlight options -inline_highlight_literals = False +#inline_highlight_literals = False # app setup hook def setup(app): app.add_config_value('recommonmark_config', { - 'url_resolver': lambda url: github_doc_root + url, + # 'url_resolver': lambda url: github_doc_root + url, # 'auto_toc_tree_section': 'Contents', 'enable_eval_rst': True, # 'enable_auto_doc_ref': True, diff --git a/site/src/site/sphinx/en/conf.py b/site/src/site/sphinx/en/conf.py index 2574dd792..d05211eeb 100644 --- a/site/src/site/sphinx/en/conf.py +++ b/site/src/site/sphinx/en/conf.py @@ -38,7 +38,7 @@ extensions = [ 'sphinx.ext.napoleon', 'sphinx.ext.mathjax', 'sphinx_markdown_tables', - 'sphinxcontrib.inlinesyntaxhighlight', +# 'sphinxcontrib.inlinesyntaxhighlight', 'highlightjs', ] @@ -305,12 +305,12 @@ texinfo_documents = [ #texinfo_no_detailmenu = False # sphinxcontrib-inlinesyntaxhighlight options -inline_highlight_literals = False +#inline_highlight_literals = False # app setup hook def setup(app): app.add_config_value('recommonmark_config', { - 'url_resolver': lambda url: github_doc_root + url, + # 'url_resolver': lambda url: github_doc_root + url, # 'auto_toc_tree_section': 'Contents', 'enable_eval_rst': True, # 'enable_auto_doc_ref': True,