updating documentation

Author: Evelin Amorim

.readthedocs.yaml

@@ -0,0 +1,16 @@
+version: 2
+
+build:
+  os: "ubuntu-22.04"
+  tools:
+    python: "3.8"
+
+python:
+  install:
+    - requirements: requirements.txt
+    # Install our python package before building the docs
+    - method: pip
+      path: .
+
+sphinx:
+  configuration: docs/source/conf.py

pyproject.toml

@@ -6,7 +6,7 @@ build-backend = "setuptools.build_meta"
 
 [tool.poetry]
 name = "text2story"
-version = "1.4.9"
+version = "1.5.0"
 readme = "README.md"
 long_description = "file: README.md"
 long_description_content_type = "text/markdown"

setup.cfg

@@ -1,7 +1,7 @@
 [metadata]
 description-file = README.md
 name = text2story
-version = 1.4.9
+version = 1.5.0
 long_description = file: README.md
 long_description_content_type = text/markdown
 url = https://github.com/LIAAD/Text2StoryPackage

text2story/__init__.py

@@ -1,12 +1,38 @@
 # Version of the text2story package
 __version__ = "1.0.0"
 
+from typing import List
+
 from text2story.annotators import load
 from text2story.annotators import get_available_tools
 from text2story.annotators import get_participant_tools
 from text2story.annotators import get_event_tools
 from text2story.annotators import get_time_tools
 from text2story.annotators import get_srlink_tools
+from text2story.annotators import add_tool, get_tool_list
+
+def get_tools(narrative_component:str):
+    """
+    get the tools for the given narrative component
+    @param narrative_component:
+    @return: a dicionary of tools and the languages it process
+    """
+    get_tool_list(narrative_component)
+
+def add_annotator(tool_name:str, lang_lst:List[str], tool_types:List[str]):
+    """
+    It adds a tool to the gallery of annotators.
+
+    @param tool: the name of the module where is your annotator
+    @param lang_lst: a list of languages supported by your custom annotator,
+                        for instance, ['en','fr']
+    @param tool_types: a list of types that your annotator labels. The
+                     supported types are ['participant','time', 'event','objectal_links',
+                     'semantic_links']
+    @return: None
+    """
+
+    add_tool(tool_name,lang_lst,tool_types)
 
 def start(lang):
     load(lang)