gradientgrove 0.1.5.dev1__tar.gz → 0.1.7__tar.gz

{gradientgrove-0.1.5.dev1/src/gradientgrove.egg-info → gradientgrove-0.1.7}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: gradientgrove
-Version: 0.1.5.dev1
+Version: 0.1.7
 Summary: Python scripts for teaching and scholarship, under development.  Currently contains scripts that allow the creation of both documents and slideshow from a single Markdown file, or a Mkdocs project.  Create a markdown file with mkdocs-style admonitions, compile to html, revealjs, latex, and beamer outputs.
 Author-email: Stephen Flood <stephen.flood@bridgew.edu>
 License-Expression: GPL-3.0-only
@@ -55,7 +55,8 @@ PYTHONPATH=src python -m gradientgrove.markdown_ast --help
 ```
 ---
 title : "My Document"
-author: "Firstname Lastname"
+author: 
+- Firstname Lastname
 ---
 
 # Background

{gradientgrove-0.1.5.dev1 → gradientgrove-0.1.7}/README.md

@@ -37,7 +37,8 @@ PYTHONPATH=src python -m gradientgrove.markdown_ast --help
 ```
 ---
 title : "My Document"
-author: "Firstname Lastname"
+author: 
+- Firstname Lastname
 ---
 
 # Background

{gradientgrove-0.1.5.dev1 → gradientgrove-0.1.7}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "gradientgrove"
-version = "0.1.5.dev1"         #   dev versions with "0.1.5.dev1"
+version = "0.1.7"         #   dev versions with "0.1.5.dev1"
 authors = [
     {name="Stephen Flood", email="stephen.flood@bridgew.edu"}
 ]

{gradientgrove-0.1.5.dev1 → gradientgrove-0.1.7}/src/gradientgrove/gradientgrove.css

@@ -28,6 +28,8 @@
 --gg-math-border: #9fb8c8;
 --gg-math-accent: #50758d;
 --gg-math-title: #294b61;    
+    --gg-exercise-bg: #f3f6f1;
+    --gg-exercise-border: #819276;
 }
 
 
@@ -43,7 +45,7 @@ html {
     line-height: 1.5;
 }
 
-body.markdown-body {
+body {
     min-width: 200px;
     max-width: 980px;
     margin: 0 auto;
@@ -70,6 +72,10 @@ h4 { font-size: 1em; }
 h5 { font-size: 0.875em; }
 h6 { font-size: 0.85em; color: var(--gg-muted); }
 
+dt {
+    font-weight: bold;
+}
+
 p, blockquote, ul, ol, dl, table, pre, details, .admonition {
     margin-top: 0;
     margin-bottom: 1rem;
@@ -183,6 +189,19 @@ summary {
     cursor: pointer;
 }
 
+.admonition.frame,
+details.frame {
+    background: #fff;
+    border: 1px solid var(--gg-border);
+}
+
+.admonition.exercise,
+details.exercise {
+    background: var(--gg-exercise-bg);
+    border: 1px solid var(--gg-exercise-border);
+    border-left: 0.35rem solid var(--gg-exercise-border);
+}
+
 .admonition.theorem,
 .admonition.define,
 .admonition.definition,
@@ -241,6 +260,21 @@ details > :last-child {
     margin-bottom: 0;
 }
 
+.gg-maketitle {
+    font-size: 1.25em;
+    text-align: center;
+    margin: 2rem 0 3rem;
+}
+
+.gg-maketitle h1 {
+    margin-bottom: 0.5rem;
+}
+
+.gg-maketitle-author,
+.gg-maketitle-date {
+    margin: 0.25rem 0;
+}
+
 .gg-transparent-env {
     display: contents;
 }
@@ -249,16 +283,17 @@ details > :last-child {
     box-sizing: border-box;
     width: 8.5in;
     min-height: 11in;
-    margin: 1rem auto;
+    /*margin: 1rem auto;*/
+    margin: 0in;
     padding: 0.75in;
     background: var(--gg-bg);
     box-shadow: 0 0 0.2in rgb(0 0 0 / 15%);
-    break-before: page;
+    /* break-before: page; */
     break-after: page;
 }
 
 .gg-page-content {
-    min-height: 9.5in;
+    min-height: 9in;
     display: flex;
     flex-direction: column;
 }
@@ -266,7 +301,9 @@ details > :last-child {
 .gg-vfill {
     flex: 1 1 auto;
 }
-
+.gg-vfillbox {
+    border: 1px solid currentColor;
+}
 .gg-vspace {
     flex: 0 0 auto;
 }
@@ -275,56 +312,56 @@ details > :last-child {
     break-before: page;
 }
 
-@media (max-width: 52rem) {
-    body.markdown-body {
-        padding: 1rem;
-    }
-
-    .gg-page {
-        width: 100%;
-        min-height: 0;
-        margin: 0;
-        padding: 1rem;
-        box-shadow: none;
-    }
+.gg-question {
+    margin: 1em 0;
+    display: flex;
+    flex-direction: column;
+}
+.gg-question:has(.gg-vfill) {
+    flex: 1 1 auto;
+}
+.gg-question-2 {
+    margin-left: 2em;
+}
+.gg-question-3 {
+    margin-left: 4em;
 }
 
 @media print {
     @page {
         size: letter;
-        margin: 1in;
+        /* margin: 1in; */
+        margin-bottom:0in;
+        padding: 0;
     }
 
     html,
     body {
-        width: 8.5in;
-        min-height: 11in;
+        margin: 0;
+        padding: 0;
         background: white;
         color: black;
-
-        font-size: 10pt;
+        font-size: 9pt;
         font-family: serif;
     }
-
-    body.markdown-body {
-        max-width: none;
-        margin: 0;
-        padding: 0.75in;
-    }
-
-    body.markdown-body:has(.gg-page) {
-        padding: 0;
-    }
-
     .gg-page {
+        height: 9in;
+        min-height: 0;
+        width: 100%;
         margin: 0;
+        padding: 0;
         box-shadow: none;
-        background: white;
-        color: black;
     }
-
+    .gg-page-content {
+        height: 100%;
+        min-height: 0;
+    }
+    .gg-vfill {
+        flex: 1 1 0;
+    }
+    
     a {
         color: inherit;
         text-decoration: underline;
     }
-}
+}

{gradientgrove-0.1.5.dev1 → gradientgrove-0.1.7}/src/gradientgrove/latex_fast_renderer.py

@@ -31,8 +31,9 @@ LATEX_RULES = {
     "em":         (Template("\\emph{$body}"), "tex"),
     "i":          (Template("\\emph{$body}"), "tex"),
     "code":       (Template("\\lstinline`$raw`"), "raw"),
-    "a":          (Template("\\href{$href}{$body}"), "tex"),
-
+    # "a":          (Template("\\href{$href}{$body}"), "tex"),
+    "a":          (Template("\\href{$href}{$body}\\footnote{\\url{$href}}"),"tex"),
+    
     # Start list environments with a newline so nested lists do not attach to prior item text.
     "ul":         (Template("\n\\begin{itemize}\n$body\\end{itemize}\n\n"), "tex"),
     "ol":         (Template("\n\\begin{enumerate}\n$body\\end{enumerate}\n\n"), "tex"),
@@ -123,14 +124,38 @@ def render_latex_fast(root, omit_envs=None, transparent_envs=None):
         if node.kind == "document":
             return "".join(render(child) for child in node.children)
 
+        ### CONTROLLING SPACING and PAGEBREAKS
+         
         if node.name == "page":
             return  "\n\\newpage\n" + body(node) + "\n\\newpage\n"
 
         if node.name == "newpage":
             return "\n\\newpage\n"
-
+        
+        # if node.name == "vfill":
+        #     return "\n\\vspace{\\stretch{1}}\n"
         if node.name == "vfill":
-            return "\n\\vspace{\\stretch{1}}\n"
+            stretch = (node.title or "").strip()
+            if stretch.lower() in {"", "vfill"}:
+                stretch = "1"
+            return f"\n\\vspace{{\\stretch{{{stretch}}}}}\n"
+
+        # if node.name == "vfillbox":
+        #     # return "\n\\begin{tcolorbox}[height fill]\n\\end{tcolorbox}\n"
+        #     # return "\n\\begin{tcolorbox}\\vspace{\\stretch{1}}\\end{tcolorbox}\n"
+        #     return "\n\\noindent\\rule[-1em]{.4pt}{1em}\\hrulefill\\rule[-1em]{.4pt}{1em}\\par\\vspace{\\stretch{1}}\\par\\noindent\\rule{.4pt}{1em}\\hrulefill\\rule{.4pt}{1em}\\par"
+
+        if node.name == "vfillbox":
+            stretch = (node.title or "").strip()
+            if stretch.lower() in {"", "vfillbox"}:
+                stretch = "1"
+            return (
+                "\n\\noindent\\rule[-1em]{.4pt}{1em}"
+                "\\hrulefill\\rule[-1em]{.4pt}{1em}\\par"
+                f"\\vspace{{\\stretch{{{stretch}}}}}\\par"
+                "\\noindent\\rule{.4pt}{1em}"
+                "\\hrulefill\\rule{.4pt}{1em}\\par"
+            )
 
         if node.name == "vspace":
             amount = (node.title or "").strip()
@@ -138,6 +163,92 @@ def render_latex_fast(root, omit_envs=None, transparent_envs=None):
                 amount = "1in"
             return f"\n\\vspace{{{amount}}}\n"
 
+        if node.name == "vspacebox":
+            amount = (node.title or "").strip()
+            if amount.lower() in {"", "vspacebox"}:
+                amount = "1in"
+            #return f"\n\\noindent\\framebox[\\linewidth]{{\\rule{{0pt}}{{{amount}}}}}\\par\n"
+
+            return (
+                f"\n\\begin{{tcolorbox}}["
+                f"height={amount},"
+                "colback=white,"
+                "colframe=black,"
+                "arc=0pt,"
+                "boxrule=0.4pt"
+                "]\n"
+                "\\end{tcolorbox}\n"
+            )
+
+        ### FORMATTING DOCUMENTS 
+        if node.name == "maketitle":
+            return "\n\\maketitle"
+
+        if node.tag == "div" and "toc" in node.attrs.get("class", "").split():
+            return "\n\\tableofcontents\n"
+
+
+        ### EXAM-LIKE ENVIRONMENT
+        if node.name == "exam":
+            # return "\n\\begin{enumerate}\n" + body(node) + "\\end{enumerate}\n"
+            out = ""
+            questions_started = False
+            for c in node.children:
+                if c.name == "question" and not questions_started:
+                    out += "\n\\begin{enumerate}\n"
+                    questions_started = True
+                out += render(c)
+            if questions_started:
+                out += "\n\\end{enumerate}\\n"
+            return out
+
+        if node.name == "question":
+
+            points = (node.title or "").strip()
+            points = f"({points} points)" if points.isdigit() else ""
+            out = f"\n\\item {points}\n"
+
+            has_subparts = False
+
+            for c in node.children:
+                if c.name =="question" and not has_subparts:
+                        out += "\n\\begin{enumerate}\n"
+                        has_subparts = True
+                out += render(c)
+
+            if has_subparts:
+                out += "\\end{enumerate}\n"
+                
+            return out
+
+
+        if node.name == "gradetable":
+            exam = node.parent
+            questions = [
+                child for child in exam.children
+                if child.name == "question"
+            ]
+            cols = "|c|" + "|".join(["c" for qn in questions]) + "|c|"
+            title_row = "Question & "  + " & ".join( [ qn.attrs["number"] for qn in questions ] )
+            points_row = "Points & " + " & ".join([ qn.attrs["points"] for qn in questions])
+            score_row = "Score & " + " & ".join([ " " for qn in questions ])
+
+            total = sum([ int(qn.attrs["points"]) for qn in questions])
+
+            return (
+                "\n\\begin{center}\n"
+                + "\\setlength{\\tabcolsep}{1em} \n {\\renewcommand{\\arraystretch}{1.75} \n"
+                + "\\begin{tabular}{"+cols+"}\n\\hline\n"
+                + title_row + " & Total \\\\ \\hline \n"
+                + points_row + " & " + str(total) + "\\\\ \\hline \n"
+                + score_row +  " & \\\\ \\hline" 
+                + "\\end{tabular}\n"
+                + "\\end{center}\n"
+            )
+
+
+
+        ### OTHER THINGS: 
         key = node.name if node.kind in {"admonition", "details"} else (node.tag or node.name)
 
         # Math produced by pymdownx.arithmatex is already LaTeX-like content.
@@ -146,9 +257,21 @@ def render_latex_fast(root, omit_envs=None, transparent_envs=None):
             math = raw(node).strip("\n")
             return f"\n\n{math}\n\n" if key == "div" else math
 
-        if key == "img":  # Render image 
+        # if key == "img":  # Render image 
+            # src = node.attrs.get("src", "")
+            # return rf"\includegraphics[width=\linewidth]{{{src}}}"
+
+        if key == "img":
             src = node.attrs.get("src", "")
-            return rf"\includegraphics[width=\linewidth]{{{src}}}"
+            width = (node.attrs.get("width") or "").strip()
+
+            if width.endswith("%"):
+                fraction = float(width[:-1]) / 100
+                width = f"{fraction:g}\\linewidth"
+            elif not width:
+                width = "\\linewidth"
+
+            return rf"\includegraphics[width={width}]{{{src}}}"
 
         if key not in LATEX_RULES:
             if node.kind in {"admonition", "details"}:

{gradientgrove-0.1.5.dev1 → gradientgrove-0.1.7}/src/gradientgrove/latex_fence.py

@@ -51,6 +51,7 @@ WRAPPER = r"""
 
 \usetikzlibrary{graphs, graphdrawing}
 \usegdlibrary{trees}
+\usepackage{forest}
 
 %%
 \tikzstyle{decision} = [diamond, draw, fill=gray!10, text width=6em, text badly centered, inner sep=0pt]
@@ -85,12 +86,50 @@ WRAPPER = r"""
 %%%% End: TikZ SPLINE 
 
 \usepackage{beamerarticle}
+\usetikzlibrary{overlay-beamer-styles}
 \begin{document}
 \noindent 
 %s
 \end{document}
 """.strip()
 
+BEAMER_WRAPPER = (
+    WRAPPER
+    .replace(
+        r"\documentclass[border=1pt]{standalone}",
+        (
+            r"\def\pgfsysdriver{pgfsys-dvisvgm.def}"
+            "\n"
+            r"\documentclass[beamer]{standalone}"
+        ),
+        1,
+    )
+    .replace(
+        r"\usepackage{beamerarticle}",
+        "",
+        1,
+    )
+    .replace(
+        r"\begin{document}",
+        (
+            r"\setbeamercolor{background canvas}{bg=}"
+            "\n"
+            r"\begin{document}"
+            "\n"
+            r"\begin{standaloneframe}[plain]"
+        ),
+        1,
+    )
+    .replace(
+        r"\end{document}",
+        (
+            r"\end{standaloneframe}"
+            "\n"
+            r"\end{document}"
+        ),
+        1,
+    )
+)
 
 def _compile_to_svg(latex_body: str) -> bytes:
     latex_src = WRAPPER % latex_body
@@ -124,6 +163,76 @@ def _compile_to_svg(latex_body: str) -> bytes:
         return (td / "x.svg").read_bytes()
 
 
+def _compile_to_overlay_svgs(latex_body: str) -> list[bytes]:
+    """Special code to handle beamer-style multi-page output"""
+    latex_src = BEAMER_WRAPPER % latex_body
+
+    with tempfile.TemporaryDirectory() as td:
+        td = Path(td)
+        (td / "x.tex").write_text(latex_src, encoding="utf-8")
+
+        # p = subprocess.run(
+        #     ["lualatex", "-halt-on-error", "-interaction=nonstopmode", "x.tex"],
+        #     cwd=td,
+        #     stdout=subprocess.PIPE,
+        #     stderr=subprocess.STDOUT,
+        #     text=True,
+        # )
+        p = subprocess.run(
+            [
+                "lualatex",
+                "--output-format=dvi",
+                "-halt-on-error",
+                "-interaction=nonstopmode",
+                "x.tex",
+            ],
+            cwd=td,
+            stdout=subprocess.PIPE,
+            stderr=subprocess.STDOUT,
+            text=True,
+        )
+        if p.returncode != 0:
+            raise RuntimeError(p.stdout)
+
+        # p = subprocess.run(
+        #     [
+        #         "dvisvgm",
+        #         "--no-fonts",
+        #         "--pdf",
+        #         "--page=1-",
+        #         str(td / "x.pdf"),
+        #         "-o",
+        #         str(td / "x-%p.svg"),
+        #     ],
+        #     cwd=td,
+        #     stdout=subprocess.PIPE,
+        #     stderr=subprocess.STDOUT,
+        #     text=True,
+        # )
+        p = subprocess.run(
+            [
+                "dvisvgm",
+                "--no-fonts",
+                "--page=1-",
+                str(td / "x.dvi"),
+                "-o",
+                str(td / "x-%p.svg"),
+            ],
+            cwd=td,
+            stdout=subprocess.PIPE,
+            stderr=subprocess.STDOUT,
+            text=True,
+        )
+        if p.returncode != 0:
+            raise RuntimeError(p.stdout)
+
+        svg_paths = sorted(
+            td.glob("x-*.svg"),
+            key=lambda p: int(p.stem.rsplit("-", 1)[1]),
+        )
+
+        return [p.read_bytes() for p in svg_paths]
+
 def latex_svg_fence(source, language, css_class, options, md, **kwargs):
     """Render a LaTeX/TikZ fenced block as an embedded SVG image.
 
@@ -232,4 +341,128 @@ def latex_cache_fence(source, language, css_class, options, md, **kwargs):
         )
 
     data_uri = "data:image/svg+xml;base64," + base64.b64encode(svg).decode("ascii")
-    return f'<img class="{html.escape(css_class)}" src="{data_uri}" alt="{html.escape(alt)}" />'
+
+    ## ORIGINAL: Embed a single svg image
+    # return f'<img class="{html.escape(css_class)}" src="{data_uri}" alt="{html.escape(alt)}" />'
+
+    ## NEW: handle latex that compiles to multiple pages (e.g. tikz from beamer)
+
+    # This is the ordinary image.
+    plain_img = (
+        f'<img class="{html.escape(css_class)}" '
+        f'src="{data_uri}" '
+        f'alt="{html.escape(alt)}" />'
+    )
+
+    # Try compiling a Beamer version.
+    overlay_hash = hashlib.sha256(
+        (BEAMER_WRAPPER + "\0" + source).encode("utf-8")
+    ).hexdigest()
+
+    def overlay_number(path):
+        return int(path.stem.rsplit("-", 1)[1])
+
+    overlay_paths = sorted(
+        cache_dir.glob(f"{overlay_hash}-*.svg"),
+        key=overlay_number,
+    )
+
+    try:
+        if overlay_paths:
+            overlay_svgs = [
+                path.read_bytes()
+                for path in overlay_paths
+            ]
+        else:
+            overlay_svgs = _compile_to_overlay_svgs(source)
+
+            for i, overlay_svg in enumerate(
+                overlay_svgs,
+                start=1,
+            ):
+                path = cache_dir / f"{overlay_hash}-{i}.svg"
+                path.write_bytes(overlay_svg)
+
+    except Exception as e:
+        print("BEAMER OVERLAY ERROR:")
+        print(e)
+
+        # Beamer failed. Just use the normal image.
+        return plain_img
+
+    # One Beamer page means there are no overlays.
+    if len(overlay_svgs) <= 1:
+        return plain_img
+
+    # Only now do we create a static image that Reveal should hide.
+    static_img = (
+        f'<img class="{html.escape(css_class)} latex-static" '
+        f'src="{data_uri}" '
+        f'alt="{html.escape(alt)}" />'
+    )
+
+    # Build one image for each Beamer page.
+    overlay_images = []
+
+    for i, overlay_svg in enumerate(overlay_svgs, start=1):
+        overlay_uri = (
+            "data:image/svg+xml;base64,"
+            + base64.b64encode(overlay_svg).decode("ascii")
+        )
+
+        classes = html.escape(css_class)
+
+        if i > 1:
+            classes += " fragment"
+
+        page_alt = html.escape(
+            f"{alt}, step {i} of {len(overlay_svgs)}"
+        )
+
+        overlay_images.append(
+            f'<img class="{classes}" '
+            f'src="{overlay_uri}" '
+            f'alt="{page_alt}" />'
+        )
+
+    #
+    # Scope all of the CSS to THIS type of wrapper.
+    #
+    # Normal HTML:
+    #     static image visible
+    #     overlay pages hidden
+    #
+    # Reveal:
+    #     static image hidden
+    #     overlay pages visible
+    return (
+        "<style>"
+        ".latex-overlay-wrapper .latex-overlays{"
+        "display:none;"
+        "}"
+
+        ".reveal .latex-overlay-wrapper .latex-static{"
+        "display:none !important;"
+        "}"
+
+        ".reveal .latex-overlay-wrapper .latex-overlays{"
+        "display:grid;"
+        "}"
+
+        ".reveal .latex-overlay-wrapper .latex-overlays img{"
+        "grid-area:1/1;"
+        "margin:auto;"
+        "}"
+
+        ".reveal .latex-overlay-wrapper .latex-overlays img.fragment{"
+        "background:var(--r-background-color,white);"
+        "}"
+        "</style>"
+
+        '<div class="latex-overlay-wrapper">'
+        + static_img
+        + '<div class="latex-overlays">'
+        + "".join(overlay_images)
+        + "</div>"
+        + "</div>"
+    )