use type annotations in API docs

Author: jhrmnn

caf/graph.py

@@ -42,6 +42,9 @@ class Action(Enum):
     EXECUTE = 1
     TRAVERSE = 2
 
+    def __repr__(self) -> str:
+        return self.name
+
 
 class Step(NamedTuple):
     action: Action

caf/sessions.py

@@ -222,7 +222,7 @@ def add_side_effect_of(self, caller: Task[object], callee: Task[object]) -> None
     def create_task(
         self, corofunc: Corofunc[_T], *args: Any, **kwargs: Any
     ) -> Task[_T]:
-        """Create new task.
+        """Create a new task.
 
         :param corofunc: a coroutine function to be executed
         :param args: arguments to the coroutine

docs/conf.py

@@ -1,11 +1,14 @@
 import os
 import sys
 import datetime
+import warnings
 
 import toml
 
 sys.path.insert(0, os.path.abspath('..'))
 
+warnings.filterwarnings('ignore', r'formatargspec\(\) is now deprecated.')
+
 with open('../pyproject.toml') as f:
     metadata = toml.load(f)['tool']['poetry']
 
@@ -19,6 +22,7 @@
     'sphinx.ext.todo',
     'sphinx.ext.viewcode',
     'sphinxcontrib.asyncio',
+    'sphinx_autodoc_typehints',
 ]
 source_suffix = '.rst'
 master_doc = 'index'

pyproject.toml

@@ -38,14 +38,20 @@ toml = { version = "^0.9.6", optional = true }
 click = { version = "^7.0", optional = true }
 pytest-mock = { version = "^1.10", optional = true }
 sphinxcontrib-asyncio = { version = "^0.2.0", optional = true }
+sphinx-autodoc-typehints = { version = "^1.3", optional = true }
 
 [tool.poetry.extras]
 cli = ["click", "toml"]
 graphviz = ["graphviz"]
 sci = ["numpy", "textx"]
 test = ["pytest", "pytest-mock"]
 cov = ["coverage"]
-doc = ["sphinx", "toml", "sphinxcontrib-asyncio"]
+doc = [
+    "sphinx",
+    "toml",
+    "sphinxcontrib-asyncio",
+    "sphinx-autodoc-typehints"
+]
 
 [tool.poetry.dev-dependencies]
 mypy = "^0.641.0"