nvim-doc-reader 0.1.0__tar.gz → 0.1.1__tar.gz

{nvim_doc_reader-0.1.0 → nvim_doc_reader-0.1.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: nvim-doc-reader
-Version: 0.1.0
+Version: 0.1.1
 Summary: Keyboard-driven HTML reader for Markdown docs, with jumps into running Neovim
 Requires-Python: >=3.9
 Description-Content-Type: text/markdown

{nvim_doc_reader-0.1.0 → nvim_doc_reader-0.1.1}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "nvim-doc-reader"
-version = "0.1.0"
+version = "0.1.1"
 description = "Keyboard-driven HTML reader for Markdown docs, with jumps into running Neovim"
 readme = "README.md"
 requires-python = ">=3.9"

{nvim_doc_reader-0.1.0 → nvim_doc_reader-0.1.1}/src/doc_reader/model.py

@@ -83,6 +83,8 @@ def make_markdown():
   md.add_render_rule("link_open", _link_open)
   md.add_render_rule("image", _image)
   md.add_render_rule("list_item_open", _list_item_open)
+  md.add_render_rule("table_open", _table_open)
+  md.add_render_rule("table_close", _table_close)
   return md
 
 
@@ -277,5 +279,16 @@ def _list_item_open(self, tokens, idx, options, env):
   return self.renderToken(tokens, idx, options, env)
 
 
+# The wrapper is what reader.css widens past the text column and scrolls when
+# the table outgrows the screen; tabindex lets the arrow keys scroll it.
+def _table_open(self, tokens, idx, options, env):
+  return ('<div class="dr-table" tabindex="0">'
+          + self.renderToken(tokens, idx, options, env))
+
+
+def _table_close(self, tokens, idx, options, env):
+  return self.renderToken(tokens, idx, options, env) + "</div>\n"
+
+
 # After the render rules it refers to.
 _MD = make_markdown()

{nvim_doc_reader-0.1.0 → nvim_doc_reader-0.1.1}/src/doc_reader/skills/doc-authoring/SKILL.md

@@ -42,6 +42,19 @@ Add them where they help understanding, not for decoration.
 - Reference assets with relative paths, give images alt text, and say in the
   prose what the figure shows.
 
+## Tables
+
+A table is for comparing a few things on a few measures; a dataframe dump is
+not a table.
+
+- About 8 columns at most. More than that: transpose (measures as rows), split
+  it by topic, or keep the full data as a CSV in `figures/` and show only the
+  columns that make the point.
+- The first column names the row; the reader keeps it in view when a wide
+  table scrolls.
+- Units in the header (`pnl $k`, `lat us`), not in every cell; round to the
+  digits that matter; right-align numeric columns with `---:`.
+
 ## Honesty
 
 - Never fabricate empirical results. Numbers come from a run you can point

{nvim_doc_reader-0.1.0 → nvim_doc_reader-0.1.1}/src/doc_reader/static/reader.css

@@ -106,8 +106,38 @@ pre { background: var(--code-bg); padding: 12px 14px; border-radius: 6px; overfl
 pre code { background: none; padding: 0; }
 pre.mermaid { background: none; text-align: center; }
 blockquote { border-left: 3px solid var(--rule); margin-left: 0; padding-left: 14px; color: var(--dim); }
-table { border-collapse: collapse; display: block; overflow-x: auto; }
-th, td { border: 1px solid var(--rule); padding: 5px 10px; text-align: left; }
+/* A table as wide as it needs, up to the screen: narrow ones stay left in the
+   column, wide ones grow out of it centred on it. One wider than the screen or
+   taller than 80vh scrolls inside the box, which keeps its header row and
+   first column in view. Separate borders: collapsed ones scroll off sticky cells,
+   and backgrounds clipped to the padding so a sticky cell's cannot cover its
+   neighbour's border. */
+.dr-table {
+  width: max-content;
+  min-width: 100%;
+  max-width: calc(100vw - 48px);
+  max-height: 80vh;
+  overflow: auto;
+  position: relative;
+  left: 50%;
+  transform: translateX(-50%);
+  margin: 0 0 1em;
+}
+@media (min-width: 1180px) {
+  body.show-outline .dr-table { max-width: calc(100vw - var(--outline-w) - 48px); }
+}
+table { border-collapse: separate; border-spacing: 0; font-size: 14px; }
+.dr-table table { margin: 0; }
+th, td { border: solid var(--rule); border-width: 0 1px 1px 0; padding: 5px 10px;
+         text-align: left; font-variant-numeric: tabular-nums;
+         background: var(--bg); background-clip: padding-box; }
+tr > :first-child { border-left-width: 1px; }
+thead tr:first-child > * { border-top-width: 1px; }
+/* Row labels and numbers stay on one line; headers and prose cells wrap. */
+td[style*="right"], .dr-table tr > :first-child { white-space: nowrap; }
+.dr-table thead th { position: sticky; top: 0; z-index: 1; background: var(--code-bg); }
+.dr-table tr > :first-child { position: sticky; left: 0; }
+.dr-table thead th:first-child { z-index: 2; }
 img { max-width: 100%; height: auto; }
 div.math { overflow-x: auto; margin: 0 0 1em; }
 ul.listing { list-style: none; padding: 0; }

{nvim_doc_reader-0.1.0 → nvim_doc_reader-0.1.1}/src/doc_reader/static/reader.js

@@ -27,6 +27,7 @@
     return false;
   }
   const visible = () => sections().filter((s) => !hidden(s));
+  const tables = () => [...docEl.querySelectorAll(".dr-table")];
   // Section IDs come from the document, so look only among its sections: a
   // heading may be called anything, including what the page itself uses.
   const byId = (id) =>
@@ -378,7 +379,11 @@
     return { collapsed: sections().filter(collapsed).map((s) => s.id),
              cur: cur && cur.id,
              offset: cur ? heading(cur).getBoundingClientRect().top : null,
-             scrollY: window.scrollY };
+             scrollY: window.scrollY,
+             // Matched back by position: an edit rarely adds a table above
+             // the one being read.
+             tables: tables().map((t) => [t.scrollLeft, t.scrollTop]),
+             focusedTable: tables().indexOf(document.activeElement) };
   }
   function applyState(state) {
     (state.collapsed || []).forEach((id) => { const s = byId(id); if (s && s.tagName === "SECTION") s.classList.add("collapsed"); });
@@ -438,6 +443,10 @@
     renderMath(docEl);
     await renderMermaid(docEl);
     if (my !== gen) return true;
+    tables().forEach((t, i) => {
+      if (snap.tables[i]) [t.scrollLeft, t.scrollTop] = snap.tables[i];
+      if (i === snap.focusedTable) t.focus({ preventScroll: true });
+    });
     if (cur && snap.offset !== null) {
       window.scrollTo({ top: window.scrollY + heading(cur).getBoundingClientRect().top - snap.offset });
     } else {

{nvim_doc_reader-0.1.0 → nvim_doc_reader-0.1.1}/src/nvim_doc_reader.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: nvim-doc-reader
-Version: 0.1.0
+Version: 0.1.1
 Summary: Keyboard-driven HTML reader for Markdown docs, with jumps into running Neovim
 Requires-Python: >=3.9
 Description-Content-Type: text/markdown

{nvim_doc_reader-0.1.0 → nvim_doc_reader-0.1.1}/tests/test_model.py

@@ -3,8 +3,15 @@
 The page, `docread url` and the Neovim jump all locate sections through this
 one parse, so these pin the cases where a naive heading scan would disagree
 with the rendered page."""
-from doc_reader import model
-import re
+import pytest
+import utils.doc_reader_src  # noqa: F401  (puts doc_reader on sys.path)
+
+# The parser needs mdit-py-plugins, which is newer than some container images.
+pytest.importorskip("mdit_py_plugins")
+
+from doc_reader import model  # noqa: E402
+import re  # noqa: E402
+from importlib import resources  # noqa: E402
 
 
 def ids(text):
@@ -86,6 +93,13 @@ def test_raw_html_is_escaped_and_mermaid_kept_as_source():
   assert '<pre class="mermaid">A --&gt; B\n</pre>' in html
 
 
+def test_the_table_wrapper_is_the_one_reader_css_styles():
+  html = model.render(model.parse("| a | n |\n|---|---:|\n| x | 1 |\n"))
+  cls = re.search(r'<div class="([\w-]+)"[^>]*><table>', html).group(1)
+  css = (resources.files("doc_reader") / "static" / "reader.css").read_text()
+  assert re.search(rf"^\.{cls} \{{", css, re.M)
+
+
 def test_project_task_rows_link_by_their_source_number():
   text = "# P\n\n3. [t] three\n7. [ ] seven\n9. [s] nine\n"
   html = model.render(model.parse(text),

{nvim_doc_reader-0.1.0 → nvim_doc_reader-0.1.1}/tests/test_nvim.py

@@ -1,18 +1,22 @@
 """`n` against real headless Neovim instances: which ones move, where they
 land, and that the target is found in the editor's text, not the disk's."""
-from doc_reader import config, nvim
-import asyncio
-import json
-import os
-import shutil
-import socket
-import subprocess
-import sys
-import tempfile
-import time
-from pathlib import Path
-
 import pytest
+import utils.doc_reader_src  # noqa: F401  (puts doc_reader on sys.path)
+
+# The parser needs mdit-py-plugins, which is newer than some container images.
+pytest.importorskip("mdit_py_plugins")
+
+from doc_reader import config, nvim  # noqa: E402
+import asyncio  # noqa: E402
+import json  # noqa: E402
+import os  # noqa: E402
+import shutil  # noqa: E402
+import socket  # noqa: E402
+import subprocess  # noqa: E402
+import sys  # noqa: E402
+import tempfile  # noqa: E402
+import time  # noqa: E402
+from pathlib import Path  # noqa: E402
 
 
 pytestmark = pytest.mark.skipif(shutil.which("nvim") is None, reason="no nvim")

{nvim_doc_reader-0.1.0 → nvim_doc_reader-0.1.1}/tests/test_serve.py

@@ -1,9 +1,15 @@
 """The server's URL handling end to end: every file has one URL, and asking
 for any other spelling of it lands there in one hop."""
-from doc_reader import config, serve
-from aiohttp.test_utils import TestClient, TestServer
-import asyncio
-import json
+import pytest
+import utils.doc_reader_src  # noqa: F401  (puts doc_reader on sys.path)
+
+# The parser needs mdit-py-plugins, which is newer than some container images.
+pytest.importorskip("mdit_py_plugins")
+
+from doc_reader import config, serve  # noqa: E402
+from aiohttp.test_utils import TestClient, TestServer  # noqa: E402
+import asyncio  # noqa: E402
+import json  # noqa: E402
 
 
 def fetch(cfg, *urls):

{nvim_doc_reader-0.1.0 → nvim_doc_reader-0.1.1}/tests/test_skill.py

@@ -1,8 +1,14 @@
 """The bundled agent skill: what `install-skill` writes is what the README
 tells people to reference, under the name Claude Code will look it up by."""
-from doc_reader import cli
-import os
-import re
+import pytest
+import utils.doc_reader_src  # noqa: F401  (puts doc_reader on sys.path)
+
+# The parser needs mdit-py-plugins, which is newer than some container images.
+pytest.importorskip("mdit_py_plugins")
+
+from doc_reader import cli  # noqa: E402
+import os  # noqa: E402
+import re  # noqa: E402
 
 
 README = os.path.join(os.path.dirname(__file__), "..", "README.md")

{nvim_doc_reader-0.1.0 → nvim_doc_reader-0.1.1}/tests/test_urls_config.py

@@ -1,4 +1,6 @@
 """Path <-> URL over named roots, and the config that defines the roots."""
+import utils.doc_reader_src  # noqa: F401  (puts doc_reader on sys.path)
+
 import os
 
 from doc_reader import config