summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorhokorobi <hokorobi.hokorobi@gmail.com>2019-01-12 23:40:03 +0900
committerw0rp <w0rp@users.noreply.github.com>2019-01-12 14:40:03 +0000
commit7f176390fc4c1b3c1a7be484e0a84c4eb8f896e3 (patch)
tree282e6c183437e2e7fe00f45b35caa8818be08793 /doc
parent56b7dca6234d9922c07ca6925a74a45af0ac3b3a (diff)
downloadale-7f176390fc4c1b3c1a7be484e0a84c4eb8f896e3.zip
Support textlint for reStructuredText (#1978)
* Support textlint for reStructuredText * Add linter test for textlint rst
Diffstat (limited to 'doc')
-rw-r--r--doc/ale-restructuredtext.txt14
-rw-r--r--doc/ale.txt3
2 files changed, 16 insertions, 1 deletions
diff --git a/doc/ale-restructuredtext.txt b/doc/ale-restructuredtext.txt
index 02fbc4ad..e308b072 100644
--- a/doc/ale-restructuredtext.txt
+++ b/doc/ale-restructuredtext.txt
@@ -3,6 +3,20 @@ ALE reStructuredText Integration *ale-restructuredtext-options*
===============================================================================
+textlint *ale-restructuredtext-textlint*
+
+To use textlint at reStructuredText, please install `textlint-plugin-rst`.
+https://github.com/jimo1001/textlint-plugin-rst
+>
+ $ npm install textlint-plugin-rst
+
+To install `textlint-plugin-rst`, `docutils-ast-writer` python package
+must be installed.
+See: https://github.com/jimo1001/docutils-ast-writer
+
+See |ale-text-textlint|
+
+===============================================================================
write-good *ale-restructuredtext-write-good*
See |ale-write-good-options|
diff --git a/doc/ale.txt b/doc/ale.txt
index 27d91605..6088b94b 100644
--- a/doc/ale.txt
+++ b/doc/ale.txt
@@ -278,6 +278,7 @@ CONTENTS *ale-contents*
ols.................................|ale-reasonml-ols|
refmt...............................|ale-reasonml-refmt|
restructuredtext......................|ale-restructuredtext-options|
+ textlint............................|ale-restructuredtext-textlint|
write-good..........................|ale-restructuredtext-write-good|
ruby..................................|ale-ruby-options|
brakeman............................|ale-ruby-brakeman|
@@ -486,7 +487,7 @@ Notes:
* QML: `qmlfmt`, `qmllint`
* R: `lintr`
* ReasonML: `merlin`, `ols`, `refmt`
-* reStructuredText: `alex`!!, `proselint`, `redpen`, `rstcheck`, `vale`, `write-good`
+* reStructuredText: `alex`!!, `proselint`, `redpen`, `rstcheck`, `textlint`, `vale`, `write-good`
* Re:VIEW: `redpen`
* RPM spec: `rpmlint`
* Ruby: `brakeman`, `rails_best_practices`!!, `reek`, `rubocop`, `ruby`, `rufo`, `solargraph`, `standardrb`