From 4aaf28cc905bebf757b02ad911a6eed78714cac7 Mon Sep 17 00:00:00 2001
From: Maxime Dénès <mail@maximedenes.fr>
Date: Fri, 10 Feb 2017 15:52:24 +0100
Subject: Integration of a sphinx-based documentation generator.
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

The original contribution is from Clément Pit-Claudel. I updated
his code and integrated it with the Coq build system. Many improvements
by Paul Steckler (MIT).

This commit adds the infrastructure but no content.
---
 doc/sphinx/_static/notations.js | 43 +++++++++++++++++++++++++++++++++++++++++
 1 file changed, 43 insertions(+)
 create mode 100644 doc/sphinx/_static/notations.js

(limited to 'doc/sphinx/_static/notations.js')

diff --git a/doc/sphinx/_static/notations.js b/doc/sphinx/_static/notations.js
new file mode 100644
index 000000000..eb7f211e8
--- /dev/null
+++ b/doc/sphinx/_static/notations.js
@@ -0,0 +1,43 @@
+/************************************************************************/
+/*         *   The Coq Proof Assistant / The Coq Development Team       */
+/*  v      *   INRIA, CNRS and contributors - Copyright 1999-2018       */
+/* <O___,, *       (see CREDITS file for the list of authors)           */
+/*   \VV/  **************************************************************/
+/*    //   *    This file is distributed under the terms of the         */
+/*         *     GNU Lesser General Public License Version 2.1          */
+/*         *     (see LICENSE file for the text of the license)         */
+/************************************************************************/
+function annotateSup(marker) {
+    switch (marker) {
+    case "?":
+        return "This block is optional.";
+    case "*":
+        return "This block is optional, and may be repeated.";
+    case "+":
+        return "This block may be repeated.";
+    }
+}
+
+function annotateSub(separator) {
+    return "Use “" + separator + "” to separate repetitions of this block.";
+}
+
+// function translatePunctuation(original) {
+//     var mappings = { ",": "⸴" }; // ，
+//     return mappings[original] || original;
+// }
+
+function annotateNotations () {
+    $(".repeat-wrapper > sup")
+        .attr("data-hint", function() {
+            return annotateSup($(this).text());
+        }).addClass("hint--top hint--rounded");
+
+    $(".repeat-wrapper > sub")
+        .attr("data-hint", function() {
+            return annotateSub($(this).text());
+        }).addClass("hint--bottom hint--rounded");
+    //.text(function(i, text) { return translatePunctuation(text); });
+}
+
+$(annotateNotations);
-- 
cgit v1.2.3