From 2481d205f913f6093e21c57d553a2130c0a5657f Mon Sep 17 00:00:00 2001
From: Andrey Kurilin <andr.kurilin@gmail.com>
Date: Sat, 2 Jan 2016 21:33:39 +0200
Subject: [PATCH] [Docs] create utils for sphinx extensions

docutils doesn't have user-friendly interface, so it required some hacks
to simplify usage of it.

Change-Id: If37ca5575beaf03cfeffe193faddd1bfb93ca723
---
 doc/ext/utils.py | 52 ++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 52 insertions(+)
 create mode 100644 doc/ext/utils.py

diff --git a/doc/ext/utils.py b/doc/ext/utils.py
new file mode 100644
index 0000000000..01a846f984
--- /dev/null
+++ b/doc/ext/utils.py
@@ -0,0 +1,52 @@
+# All Rights Reserved.
+#
+#    Licensed under the Apache License, Version 2.0 (the "License"); you may
+#    not use this file except in compliance with the License. You may obtain
+#    a copy of the License at
+#
+#         http://www.apache.org/licenses/LICENSE-2.0
+#
+#    Unless required by applicable law or agreed to in writing, software
+#    distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+#    WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+#    License for the specific language governing permissions and limitations
+#    under the License.
+
+"""
+Docutils is awful library. Let's apply some hacks and aliases to simplify usage
+"""
+
+from docutils import frontend
+from docutils import nodes
+from docutils import utils
+from docutils.parsers import rst
+
+import six
+
+
+def parse_text(text):
+    parser = rst.Parser()
+    settings = frontend.OptionParser(components=(rst.Parser,)).get_default_values()
+    document = utils.new_document(text, settings)
+    parser.parse(text, document)
+    return document.children
+
+paragraph = lambda text: parse_text(text)[0]
+note = lambda msg: nodes.note("", paragraph(msg))
+hint = lambda msg: nodes.hint("", *parse_text(msg))
+warning = lambda msg: nodes.warning("", paragraph(msg))
+category = lambda title: parse_text("%s\n%s" % (title, "-" * len(title)))[0]
+subcategory = lambda title: parse_text("%s\n%s" % (title, "~" * len(title)))[0]
+
+
+def make_definition(term, ref, descriptions):
+    """Constructs definition with reference to it"""
+    ref = ref.replace("_", "-").replace(" ", "-")
+    definition = parse_text(
+            ".. _%(ref)s:\n\n%(term)s (ref__)\n\n__ #%(ref)s" %
+            {"ref": ref, "term": term})
+    for descr in descriptions:
+        if isinstance(descr, (six.text_type, six.binary_type)):
+            descr = paragraph("  %s" % descr)
+        definition.append(descr)
+    return definition