diff --git a/README.rst b/README.rst index 5a8663a..3ffa873 100644 --- a/README.rst +++ b/README.rst @@ -1,6 +1,21 @@ taxonomy-matcher ================= +CI Status +----------- + +.. image:: https://travis-ci.org/tilaboy/taxonomy-matcher.svg?branch=master + :target: https://travis-ci.org/tilaboy/taxonomy-matcher + +.. image:: https://pyup.io/repos/github/tilaboy/taxonomy-matcher/shield.svg + :target: https://pyup.io/repos/github/tilaboy/taxonomy-matcher/ + :alt: Updates + +.. image:: https://readthedocs.org/projects/gazetteer-matcher/badge/?version=latest + :target: https://gazetteer-matcher.readthedocs.io/en/latest/?badge=latest + :alt: Documentation Status + + Description ----------- @@ -19,26 +34,13 @@ For each match, it will return the information of, - and other code related information -CI Status ------------ - -.. image:: https://travis-ci.org/tilaboy/taxonomy-matcher.svg?branch=master - :target: https://travis-ci.org/tilaboy/taxonomy-matcher - -.. image:: https://pyup.io/repos/github/tilaboy/taxonomy-matcher/shield.svg - :target: https://pyup.io/repos/github/tilaboy/taxonomy-matcher/ - :alt: Updates - -.. image:: https://readthedocs.org/projects/gazetteer-matcher/badge/?version=latest - :target: https://gazetteer-matcher.readthedocs.io/en/latest/?badge=latest - :alt: Documentation Status - Requirements ------------ Python 3.6+ + Usage ----- diff --git a/docs/modules.rst b/docs/modules.rst new file mode 100644 index 0000000..d2c2f16 --- /dev/null +++ b/docs/modules.rst @@ -0,0 +1,7 @@ +taxonomy_matcher +================ + +.. toctree:: + :maxdepth: 4 + + taxonomy_matcher diff --git a/docs/taxonomy_matcher.match_patterns.rst b/docs/taxonomy_matcher.match_patterns.rst new file mode 100644 index 0000000..83c0199 --- /dev/null +++ b/docs/taxonomy_matcher.match_patterns.rst @@ -0,0 +1,46 @@ +taxonomy\_matcher.match\_patterns package +========================================= + +Submodules +---------- + +taxonomy\_matcher.match\_patterns.patterns module +------------------------------------------------- + +.. automodule:: taxonomy_matcher.match_patterns.patterns + :members: + :undoc-members: + :show-inheritance: + +taxonomy\_matcher.match\_patterns.patterns\_ct module +----------------------------------------------------- + +.. automodule:: taxonomy_matcher.match_patterns.patterns_ct + :members: + :undoc-members: + :show-inheritance: + +taxonomy\_matcher.match\_patterns.patterns\_gz module +----------------------------------------------------- + +.. automodule:: taxonomy_matcher.match_patterns.patterns_gz + :members: + :undoc-members: + :show-inheritance: + +taxonomy\_matcher.match\_patterns.patterns\_nt module +----------------------------------------------------- + +.. automodule:: taxonomy_matcher.match_patterns.patterns_nt + :members: + :undoc-members: + :show-inheritance: + + +Module contents +--------------- + +.. automodule:: taxonomy_matcher.match_patterns + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/taxonomy_matcher.rst b/docs/taxonomy_matcher.rst new file mode 100644 index 0000000..0852ad5 --- /dev/null +++ b/docs/taxonomy_matcher.rst @@ -0,0 +1,77 @@ +taxonomy\_matcher package +========================= + +Subpackages +----------- + +.. toctree:: + + taxonomy_matcher.match_patterns + +Submodules +---------- + +taxonomy\_matcher.data\_saver module +------------------------------------ + +.. automodule:: taxonomy_matcher.data_saver + :members: + :undoc-members: + :show-inheritance: + +taxonomy\_matcher.data\_utils module +------------------------------------ + +.. automodule:: taxonomy_matcher.data_utils + :members: + :undoc-members: + :show-inheritance: + +taxonomy\_matcher.matched\_phrase module +---------------------------------------- + +.. automodule:: taxonomy_matcher.matched_phrase + :members: + :undoc-members: + :show-inheritance: + +taxonomy\_matcher.matcher module +-------------------------------- + +.. automodule:: taxonomy_matcher.matcher + :members: + :undoc-members: + :show-inheritance: + +taxonomy\_matcher.token\_position module +---------------------------------------- + +.. automodule:: taxonomy_matcher.token_position + :members: + :undoc-members: + :show-inheritance: + +taxonomy\_matcher.token\_trie module +------------------------------------ + +.. automodule:: taxonomy_matcher.token_trie + :members: + :undoc-members: + :show-inheritance: + +taxonomy\_matcher.tokenizer module +---------------------------------- + +.. automodule:: taxonomy_matcher.tokenizer + :members: + :undoc-members: + :show-inheritance: + + +Module contents +--------------- + +.. automodule:: taxonomy_matcher + :members: + :undoc-members: + :show-inheritance: diff --git a/requirements_dev.txt b/requirements_dev.txt index c95b643..1e4a215 100644 --- a/requirements_dev.txt +++ b/requirements_dev.txt @@ -5,7 +5,7 @@ watchdog==0.9.0 flake8==3.7.8 tox==3.13.2 coverage==4.5.4 -Sphinx==2.1.2 +Sphinx==2.2.1 twine==1.13.0 pytest==5.0.1 diff --git a/setup.cfg b/setup.cfg index a2dacf9..5c1feba 100644 --- a/setup.cfg +++ b/setup.cfg @@ -1,5 +1,5 @@ [bumpversion] -current_version = 0.0.7 +current_version = 0.0.8 commit = True tag = True diff --git a/setup.py b/setup.py index 57e393a..56350ec 100644 --- a/setup.py +++ b/setup.py @@ -2,7 +2,7 @@ from setuptools import setup, find_packages NAME = "taxonomy_matcher" -VERSION = os.environ.get("TAXONOMY_MATCHER_VERSION", '0.0.7') +VERSION = os.environ.get("TAXONOMY_MATCHER_VERSION", '0.0.8') with open('README.rst', "r") as readme_file: readme = readme_file.read() diff --git a/taxonomy_matcher/__init__.py b/taxonomy_matcher/__init__.py index dee06e5..19fdc80 100644 --- a/taxonomy_matcher/__init__.py +++ b/taxonomy_matcher/__init__.py @@ -7,7 +7,7 @@ __author__ = """Chao Li""" __email__ = 'chaoli.job@google.com' -__version__ = '0.0.7' +__version__ = '0.0.8' name = "taxonomy_matcher"