summaryrefslogtreecommitdiff
path: root/sphinx/util/typing.py
diff options
context:
space:
mode:
Diffstat (limited to 'sphinx/util/typing.py')
-rw-r--r--sphinx/util/typing.py24
1 files changed, 24 insertions, 0 deletions
diff --git a/sphinx/util/typing.py b/sphinx/util/typing.py
new file mode 100644
index 000000000..20c8883e4
--- /dev/null
+++ b/sphinx/util/typing.py
@@ -0,0 +1,24 @@
+# -*- coding: utf-8 -*-
+"""
+ sphinx.util.typing
+ ~~~~~~~~~~~~~~~~~~
+
+ The composit types for Sphinx.
+
+ :copyright: Copyright 2007-2016 by the Sphinx team, see AUTHORS.
+ :license: BSD, see LICENSE for details.
+"""
+
+from six import PY3
+from typing import Callable, Dict, List, Tuple
+
+from docutils import nodes
+from docutils.parsers.rst.states import Inliner
+
+
+if PY3:
+ unicode = str
+
+# common role functions
+RoleFunction = Callable[[unicode, unicode, unicode, int, Inliner, Dict, List[unicode]],
+ Tuple[List[nodes.Node], List[nodes.Node]]]