Squashed 'vimhelp/' changes from 2e601f5..ee82db4

ychin · ychin · commit e8e9bf67f4c2 · 2023-06-12T17:05:49.000-07:00
ee82db4 Sidebar has level-2 headings if ∄ level-1 headings
b947d9b Tweak HTML
76015e2 Upgrade to Flask 2.3

git-subtree-dir: vimhelp
git-subtree-split: ee82db4ce6012d9c10529ce469ca892ee831d2e2
diff --git a/requirements.txt b/requirements.txt
@@ -1,4 +1,4 @@
-Flask ~= 2.2
+Flask ~= 2.3
 gevent ~= 22.10
 geventhttpclient ~= 2.0
 google-cloud-ndb ~= 2.1
diff --git a/templates/page.html b/templates/page.html
@@ -12,8 +12,8 @@
 <script defer src="{{static_dir}}tom-select-2.2.2.base.min.js"></script>
 {% endif %}
 
-<link rel="stylesheet" href="{{static_dir}}vimhelp-v5.css" type="text/css">
-<noscript><link rel="stylesheet" href="{{static_dir}}noscript.css" type="text/css"></noscript>
+<link rel="stylesheet" href="{{static_dir}}vimhelp-v5.css">
+<noscript><link rel="stylesheet" href="{{static_dir}}noscript.css"></noscript>
 <script defer src="{{static_dir}}vimhelp-v5.js"></script>
 </head>
 <body>
diff --git a/vimhelp/vimh2h.py b/vimhelp/vimh2h.py
@@ -1,11 +1,13 @@
 # Translates Vim documentation to HTML
 
-import flask
 import functools
 import html
 import re
 import urllib.parse
 
+import flask
+import markupsafe
+
 
 class VimProject:
     name = "Vim"
@@ -86,7 +88,10 @@ class NeovimProject:
 )
 RE_EG_START = re.compile(r"(.* )?>(?:vim|lua)?$")
 RE_EG_END = re.compile(r"[^ \t]")
-RE_SECTION = re.compile(r"(?!NOTE$|CTRL-|\.\.\.$)([A-Z.][-A-Z0-9 .,()_?]*)(?:\s+\*|$)")
+RE_SECTION = re.compile(
+    r"(?!NOTE$|UTF-8.$|VALID.$|OLE.$|CTRL-|\.\.\.$)"
+    r"([A-Z.][-A-Z0-9 .,()_?]*?)\s*(?:\s\*|$)"
+)
 RE_STARTAG = re.compile(r'\*([^ \t"*]+)\*(?:\s|$)')
 RE_LOCAL_ADD = re.compile(r"LOCAL ADDITIONS:\s+\*local-additions\*$")
 
@@ -226,11 +231,13 @@ def to_html(self, filename, contents):
 
         out = []
         sidebar_headings = []
+        sidebar_lvl = 2
         in_example = False
         for idx, line in enumerate(lines):
             prev_line = "" if idx == 0 else lines[idx - 1]
             if prev_line == "" and idx > 1:
                 prev_line = lines[idx - 2]
+
             if in_example:
                 if RE_EG_END.match(line):
                     in_example = False
@@ -239,18 +246,31 @@ def to_html(self, filename, contents):
                 else:
                     out.extend(('<span class="e">', html_escape(line), "</span>\n"))
                     continue
+
             if RE_HRULE.match(line):
                 out.extend(('<span class="h">', html_escape(line), "</span>\n"))
                 continue
+
             if m := RE_EG_START.match(line):
                 in_example = True
                 line = m.group(1) or ""
-            span_opened = False
+
+            heading = None
+            skip_to_col = None
             if m := RE_SECTION.match(line):
-                out.extend(('<span class="c">', m.group(1), "</span>"))
-                line = line[m.end(1) :]
+                heading = m.group(1)
+                heading_lvl = 2
+                out.extend(('<span class="c">', heading, "</span>"))
+                skip_to_col = m.end(1)
             elif RE_HRULE1.match(prev_line) and (m := RE_HEADING.match(line)):
                 heading = m.group(1)
+                heading_lvl = 1
+
+            span_opened = False
+            if heading is not None and sidebar_lvl >= heading_lvl:
+                if sidebar_lvl > heading_lvl:
+                    sidebar_lvl = heading_lvl
+                    sidebar_headings = []
                 if m := RE_STARTAG.search(line):
                     tag = m.group(1)
                 else:
@@ -259,8 +279,14 @@ def to_html(self, filename, contents):
                     span_opened = True
                 tag_escaped = urllib.parse.quote_plus(tag)
                 sidebar_headings.append(
-                    flask.Markup(f'<a href="#{tag_escaped}">{html_escape(heading)}</a>')
+                    markupsafe.Markup(
+                        f'<a href="#{tag_escaped}">{html_escape(heading)}</a>'
+                    )
                 )
+
+            if skip_to_col is not None:
+                line = line[skip_to_col:]
+
             is_faq_line = (
                 self._project is VimProject and is_help_txt and RE_LOCAL_ADD.match(line)
             )
@@ -335,7 +361,7 @@ def to_html(self, filename, contents):
             filename=filename,
             static_dir=static_dir,
             helptxt=helptxt,
-            content=flask.Markup("".join(out)),
+            content=markupsafe.Markup("".join(out)),
             sidebar_headings=sidebar_headings,
         )
 
diff --git a/vimhelp/vimhelp.py b/vimhelp/vimhelp.py
@@ -53,7 +53,6 @@ def handle_vimhelp(filename, cache):
 
 def prepare_response(req, head, theme):
     resp = flask.Response(mimetype="text/html")
-    resp.charset = head.encoding
     resp.last_modified = head.modified
     resp.cache_control.max_age = 15 * 60
     resp.vary.add("Cookie")

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-Flask ~= 2.2`
	`1`	`+Flask ~= 2.3`
`2`	`2`	`gevent ~= 22.10`
`3`	`3`	`geventhttpclient ~= 2.0`
`4`	`4`	`google-cloud-ndb ~= 2.1`