Skip to content

Commit 19f0d2d

Browse files
authored
Merge pull request jxmorris12#133 from mdevolde/docs
feat: added online doc link in README and pyproject
2 parents 4e5be49 + f634bbe commit 19f0d2d

File tree

2 files changed

+9
-1
lines changed

2 files changed

+9
-1
lines changed

README.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
# `language_tool_python`: a grammar checker for Python 📝
22

33
[![language tool python on pypi](https://badge.fury.io/py/language-tool-python.svg)](https://pypi.org/project/language-tool-python/)
4+
[![Documentation Status](https://readthedocs.org/projects/language-tool-python/badge/?version=latest)](https://language-tool-python.readthedocs.io/en/latest/)
45
[![Test with PyTest](https://github.com/jxmorris12/language_tool_python/workflows/Test%20with%20PyTest/badge.svg)](https://github.com/jxmorris12/language_tool_python/actions)
56
[![Downloads](https://static.pepy.tech/badge/language-tool-python)](https://pepy.tech/project/language-tool-python)
67
[![License: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](LICENSE)
@@ -10,6 +11,10 @@ Current LanguageTool version: **6.8-SNAPSHOT**
1011

1112
This is a Python wrapper for [LanguageTool](https://languagetool.org). LanguageTool is an open-source grammar tool, also known as the spellchecker for OpenOffice. This library allows you to detect grammar errors and spelling mistakes through a Python script or through a command-line interface.
1213

14+
## Documentation
15+
16+
The full documentation is available at: [https://language-tool-python.readthedocs.io/en/latest/](https://language-tool-python.readthedocs.io/en/latest/)
17+
1318
## Local and Remote Servers
1419

1520
By default, `language_tool_python` will download a LanguageTool server `.jar` and run that in the background to detect grammar errors locally. However, LanguageTool also offers a [Public HTTP Proofreading API](https://dev.languagetool.org/public-http-api) that is supported as well. Follow the link for rate limiting details. (Running locally won't have the same restrictions.)

pyproject.toml

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,6 @@ classifiers = [
2525
"Topic :: Text Processing :: Linguistic",
2626
]
2727
keywords = ["python", "nlp", "grammar", "languagetool", "grammar-checker", "spellchecker", "grammar-parser"]
28-
urls = { Repository = "https://github.com/jxmorris12/language_tool_python.git" }
2928

3029
dependencies = [
3130
"requests",
@@ -35,6 +34,10 @@ dependencies = [
3534
"toml"
3635
]
3736

37+
[project.urls]
38+
repository = "https://github.com/jxmorris12/language_tool_python.git"
39+
documentation = "https://language-tool-python.readthedocs.io/en/latest/"
40+
3841
[dependency-groups]
3942
tests = [
4043
"pytest",

0 commit comments

Comments
 (0)