upgrade sphinx-maven-plugin to 2.6.0. close #845

pull/853/head
hengyunabc 5 years ago
parent bb56e26b10
commit 582eca9e5a

@ -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 * 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` configured in [`site/pom.xml`](https://github.com/alibaba/arthas/tree/master/site)
* `sphinx-maven-plugin` executes by downloading`sphinx-binary/` * `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 execute:
* when packaging the whole project (Packaging All), you need to (Only Unix/Linux/Mac supported):
```bash ```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` * 在`site/pom.xml`里配置了`sphinx-maven-plugin`
* `sphinx-maven-plugin`通过下载`sphinx-binary/`来执行 * `sphinx-maven-plugin`通过下载`sphinx-binary/`来执行
* sphinx配置的`recommonmark`插件有bughttps://github.com/rtfd/recommonmark/issues/93 ,因此另外打包了一个修复版本: https://github.com/hengyunabc/sphinx-binary/releases/tag/v0.4.0.1 * sphinx配置的`recommonmark`插件有bughttps://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 ./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`里的版本 * 修改`as.sh`里的版本
* 修改本地的maven settings.xml * 修改本地的maven settings.xml
* mvn release:prepare -Darguments="-DskipTests" * 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 * 到 https://oss.sonatype.org/ 上“Staging Repositories”然后close掉自己的再release
* 发布完maven仓库之后需要到阿里云的仓库里检查是否同步有可能有延时 * 发布完maven仓库之后需要到阿里云的仓库里检查是否同步有可能有延时

@ -18,7 +18,7 @@
<plugin> <plugin>
<groupId>kr.motd.maven</groupId> <groupId>kr.motd.maven</groupId>
<artifactId>sphinx-maven-plugin</artifactId> <artifactId>sphinx-maven-plugin</artifactId>
<version>2.2.3</version> <version>2.6.0</version>
<executions> <executions>
<execution> <execution>
<id>zh doc</id> <id>zh doc</id>

@ -38,7 +38,7 @@ extensions = [
'sphinx.ext.napoleon', 'sphinx.ext.napoleon',
'sphinx.ext.mathjax', 'sphinx.ext.mathjax',
'sphinx_markdown_tables', 'sphinx_markdown_tables',
'sphinxcontrib.inlinesyntaxhighlight', # 'sphinxcontrib.inlinesyntaxhighlight',
'highlightjs', 'highlightjs',
] ]
@ -305,12 +305,12 @@ texinfo_documents = [
#texinfo_no_detailmenu = False #texinfo_no_detailmenu = False
# sphinxcontrib-inlinesyntaxhighlight options # sphinxcontrib-inlinesyntaxhighlight options
inline_highlight_literals = False #inline_highlight_literals = False
# app setup hook # app setup hook
def setup(app): def setup(app):
app.add_config_value('recommonmark_config', { 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', # 'auto_toc_tree_section': 'Contents',
'enable_eval_rst': True, 'enable_eval_rst': True,
# 'enable_auto_doc_ref': True, # 'enable_auto_doc_ref': True,

@ -38,7 +38,7 @@ extensions = [
'sphinx.ext.napoleon', 'sphinx.ext.napoleon',
'sphinx.ext.mathjax', 'sphinx.ext.mathjax',
'sphinx_markdown_tables', 'sphinx_markdown_tables',
'sphinxcontrib.inlinesyntaxhighlight', # 'sphinxcontrib.inlinesyntaxhighlight',
'highlightjs', 'highlightjs',
] ]
@ -305,12 +305,12 @@ texinfo_documents = [
#texinfo_no_detailmenu = False #texinfo_no_detailmenu = False
# sphinxcontrib-inlinesyntaxhighlight options # sphinxcontrib-inlinesyntaxhighlight options
inline_highlight_literals = False #inline_highlight_literals = False
# app setup hook # app setup hook
def setup(app): def setup(app):
app.add_config_value('recommonmark_config', { 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', # 'auto_toc_tree_section': 'Contents',
'enable_eval_rst': True, 'enable_eval_rst': True,
# 'enable_auto_doc_ref': True, # 'enable_auto_doc_ref': True,

Loading…
Cancel
Save