diff --git a/.gitignore b/.gitignore index db4d280..d76cb37 100644 --- a/.gitignore +++ b/.gitignore @@ -1,6 +1,10 @@ -venv +.venv activate +# Docs +docs/_api/ +docs/_build/ + # Byte-compiled / optimized / DLL files __pycache__/ *.py[cod] @@ -71,9 +75,6 @@ instance/ # Scrapy stuff: .scrapy -# Sphinx documentation -docs/_build/ - # PyBuilder target/ diff --git a/DEVELOP.md b/DEVELOP.md index b054858..def6421 100644 --- a/DEVELOP.md +++ b/DEVELOP.md @@ -1,14 +1,14 @@ # Release TODO + - change version number - make sure requirements.txt and test/requirements.txt matches setup.py. -- >> make clean -- >> make format -- >> make lint -- >> make doc -- >> make tox -- >> make tox-report +- > > make clean +- > > make lint +- > > make doc +- > > make tox +- > > make tox-report - merge to master branch -- >> make clean -- >> make upload +- > > make clean +- > > make upload diff --git a/Makefile b/Makefile index 797bcbe..0263b2e 100644 --- a/Makefile +++ b/Makefile @@ -3,9 +3,9 @@ RM = rm -rf TWINE = twine TOX = tox LINT = pylint --rcfile=./.pylintrc -FORMAT = $(PY) -m black --color --diff +FORMAT = black --color -.PHONY: all check dist sdist test tox tox-v tox-vv tox-report lint format doc upload clean +.PHONY: all check dist sdist test tox tox-v tox-vv tox-report lint doc upload clean all: dist check test @@ -17,10 +17,8 @@ sdist bdist_wheel: $(PY) setup.py $@ lint: - $(LINT) ckip_transformers - -format: $(FORMAT) ckip_transformers + $(LINT) ckip_transformers check: $(TWINE) check dist/* diff --git a/README.rst b/README.rst index 6b5b6a7..2e4b131 100644 --- a/README.rst +++ b/README.rst @@ -374,7 +374,7 @@ NLP Tools Usage .. code-block:: python # Sets the batch size and maximum sentence length - ws = ws_driver(text, batch_size=256, max_length=512) + ws = ws_driver(text, batch_size=256, max_length=128) 4. Show results """"""""""""""" diff --git a/ckip_transformers/__init__.py b/ckip_transformers/__init__.py index d740c4b..5413376 100644 --- a/ckip_transformers/__init__.py +++ b/ckip_transformers/__init__.py @@ -10,7 +10,7 @@ __copyright__ = "2020 CKIP Lab" __title__ = "CKIP Transformers" -__version__ = "0.2.7" +__version__ = "0.2.8" __description__ = "CKIP Transformers" __license__ = "GPL-3.0" diff --git a/docs/_static/custom.css b/docs/_static/custom.css index a5ab326..25ec0dc 100644 --- a/docs/_static/custom.css +++ b/docs/_static/custom.css @@ -1,26 +1,28 @@ /* header */ h1 { - font-size: 250%; + font-size: 250%; - display: inline-block; - border-bottom: 3px solid #2980b9; + display: inline-block; + border-bottom: 3px solid #2980b9; } /* content */ .rst-content p.rubric { - font-size: 125%; + font-size: 125%; } .rst-content table.docutils th p { - margin-bottom: 0; + margin-bottom: 0; } -.rst-content tt.literal, .rst-content tt.literal, .rst-content code.literal { - color: #0057A9; +.rst-content tt.literal, +.rst-content tt.literal, +.rst-content code.literal { + color: #0057a9; } .wy-nav-content { - max-width: 1280px; + max-width: 1280px; }