gradientgrove 0.1.3.dev1__tar.gz → 0.1.5__tar.gz

{gradientgrove-0.1.3.dev1 → gradientgrove-0.1.5}/PKG-INFO

@@ -1,7 +1,7 @@
 Metadata-Version: 2.4
 Name: gradientgrove
-Version: 0.1.3.dev1
-Summary: Python scripts to 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.
+Version: 0.1.5
+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
 Project-URL: Homepage, https://gradientgrove.com
@@ -11,6 +11,9 @@ Classifier: Operating System :: OS Independent
 Requires-Python: >=3.10
 Description-Content-Type: text/markdown
 License-File: LICENSE
+Requires-Dist: markdown
+Requires-Dist: mkdocs
+Requires-Dist: pymdown-extensions
 Dynamic: license-file
 
 # gradientgrove
@@ -29,10 +32,84 @@ gradientgrove-latex-to-markdown --help
 After installation, setuptools exposes the console scripts shown above. When running from a source checkout instead of an installed package, use the equivalent module form and prefix commands with `PYTHONPATH=src`:
 
 ```bash
-PYTHONPATH=src python -m gradientgrove.markdown_publish --help
+PYTHONPATH=src python -m gradientgrove.publish --help
 PYTHONPATH=src python -m gradientgrove.markdown_ast --help
 ```
 
+## Markdown Syntax
+
+- Standard Mkdocs/python-markdown syntax
+- Several additional fences, with behavior dependent on output format
+    - Contents of `frame` become slides in revealjs/beamer output.  Contents of `pause` are revealed when advancing. 
+    - A page break is inserted before and after the contents of `page`
+    - A `newpage` environment with no contents inserts a pagebreak. 
+- You cannot put (sub)*section divisions inside a `frame`
+
+| environment | article (html/pdf) | slides (revealjs/beamer) | 
+| ------- | ------ | ------ | 
+| `frame`, `pause` | ignored | yes | 
+| `newpage`, `page`, `vspace`, `vfill` | yes | ignored | 
+| `exercise`, `answer` | yes | yes | 
+| `theorem`, `definition` | yes | yes | 
+
+```
+---
+title : "My Document"
+author: "Firstname Lastname"
+---
+
+# Background
+
+!!! note 
+    Standard MkDocs/Python Markdown admonitions work
+
+??? info
+    Collapsable admonitions work too
+
+# Slideshows
+
+!!! frame "Frame Title"
+
+    Frame contents go here
+
+    !!! pause
+        Displayed when advanced
+    
+!!! exercise
+    You can put exercises between frames
+
+??? answer
+    And you can put answers too. 
+
+    Answers are **excluded** from handout mode
+
+!!! frame
+    You can put the next frame here
+
+!!! page
+    !!! exercise 
+        You can also make a worksheet with spaces
+    
+    !!! vfill
+
+    !!! exercise
+        Another exercise
+    
+    !!! vfill
+
+# Mathematics environments
+
+!!! definition 
+    Definitions work
+
+!!! theorem
+    Theorems too
+
+Currently supported environments are hardcoded into the template, particularly for latex output.
+Eventually there should be a more dynamic solution. 
+```
+
+
 ## Publishing Markdown documents
 
 `gradientgrove.markdown_publish` converts Markdown files into HTML, Reveal.js slides, LaTeX articles, LaTeX handouts, and Beamer slides.

gradientgrove-0.1.3.dev1/src/gradientgrove.egg-info/PKG-INFO → gradientgrove-0.1.5/README.md

@@ -1,18 +1,3 @@
-Metadata-Version: 2.4
-Name: gradientgrove
-Version: 0.1.3.dev1
-Summary: Python scripts to 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
-Project-URL: Homepage, https://gradientgrove.com
-Project-URL: Issues, https://gradientgrove.com
-Classifier: Programming Language :: Python :: 3
-Classifier: Operating System :: OS Independent
-Requires-Python: >=3.10
-Description-Content-Type: text/markdown
-License-File: LICENSE
-Dynamic: license-file
-
 # gradientgrove
 
 Local Python scripts for reusable Markdown, LaTeX, and publishing workflows.
@@ -29,10 +14,84 @@ gradientgrove-latex-to-markdown --help
 After installation, setuptools exposes the console scripts shown above. When running from a source checkout instead of an installed package, use the equivalent module form and prefix commands with `PYTHONPATH=src`:
 
 ```bash
-PYTHONPATH=src python -m gradientgrove.markdown_publish --help
+PYTHONPATH=src python -m gradientgrove.publish --help
 PYTHONPATH=src python -m gradientgrove.markdown_ast --help
 ```
 
+## Markdown Syntax
+
+- Standard Mkdocs/python-markdown syntax
+- Several additional fences, with behavior dependent on output format
+    - Contents of `frame` become slides in revealjs/beamer output.  Contents of `pause` are revealed when advancing. 
+    - A page break is inserted before and after the contents of `page`
+    - A `newpage` environment with no contents inserts a pagebreak. 
+- You cannot put (sub)*section divisions inside a `frame`
+
+| environment | article (html/pdf) | slides (revealjs/beamer) | 
+| ------- | ------ | ------ | 
+| `frame`, `pause` | ignored | yes | 
+| `newpage`, `page`, `vspace`, `vfill` | yes | ignored | 
+| `exercise`, `answer` | yes | yes | 
+| `theorem`, `definition` | yes | yes | 
+
+```
+---
+title : "My Document"
+author: "Firstname Lastname"
+---
+
+# Background
+
+!!! note 
+    Standard MkDocs/Python Markdown admonitions work
+
+??? info
+    Collapsable admonitions work too
+
+# Slideshows
+
+!!! frame "Frame Title"
+
+    Frame contents go here
+
+    !!! pause
+        Displayed when advanced
+    
+!!! exercise
+    You can put exercises between frames
+
+??? answer
+    And you can put answers too. 
+
+    Answers are **excluded** from handout mode
+
+!!! frame
+    You can put the next frame here
+
+!!! page
+    !!! exercise 
+        You can also make a worksheet with spaces
+    
+    !!! vfill
+
+    !!! exercise
+        Another exercise
+    
+    !!! vfill
+
+# Mathematics environments
+
+!!! definition 
+    Definitions work
+
+!!! theorem
+    Theorems too
+
+Currently supported environments are hardcoded into the template, particularly for latex output.
+Eventually there should be a more dynamic solution. 
+```
+
+
 ## Publishing Markdown documents
 
 `gradientgrove.markdown_publish` converts Markdown files into HTML, Reveal.js slides, LaTeX articles, LaTeX handouts, and Beamer slides.

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

@@ -4,13 +4,18 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "gradientgrove"
-version = "0.1.3.dev1"
+version = "0.1.5"         #   dev versions with "0.1.5.dev1"
 authors = [
     {name="Stephen Flood", email="stephen.flood@bridgew.edu"}
 ]
-description = "Python scripts to 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."
+description = "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."
 readme = "README.md"
 requires-python = ">=3.10"
+dependencies = [
+    "markdown",
+    "mkdocs",
+    "pymdown-extensions",
+]
 classifiers = [
     "Programming Language :: Python :: 3",
     "Operating System :: OS Independent",
@@ -27,5 +32,4 @@ Issues = "https://gradientgrove.com"
 
 [project.scripts]
 gradientgrove-publish = "gradientgrove.markdown_publish:main"
-gradientgrove-pdf-review = "gradientgrove.pdf_review_tool:main"
 gradientgrove-latex-to-markdown = "gradientgrove.markdown_ast:latex_to_markdown_main"

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

@@ -253,6 +253,7 @@ details > :last-child {
     padding: 0.75in;
     background: var(--gg-bg);
     box-shadow: 0 0 0.2in rgb(0 0 0 / 15%);
+    break-before: page;
     break-after: page;
 }
 
@@ -291,7 +292,7 @@ details > :last-child {
 @media print {
     @page {
         size: letter;
-        margin: 0;
+        margin: 1in;
     }
 
     html,
@@ -300,6 +301,9 @@ details > :last-child {
         min-height: 11in;
         background: white;
         color: black;
+
+        font-size: 10pt;
+        font-family: serif;
     }
 
     body.markdown-body {

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

@@ -123,6 +123,21 @@ def render_latex_fast(root, omit_envs=None, transparent_envs=None):
         if node.kind == "document":
             return "".join(render(child) for child in node.children)
 
+        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 == "vspace":
+            amount = (node.title or "").strip()
+            if amount.lower() in {"", "vspace"}:
+                amount = "1in"
+            return f"\n\\vspace{{{amount}}}\n"
+
         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.
@@ -131,6 +146,10 @@ 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 
+            src = node.attrs.get("src", "")
+            return rf"\includegraphics[width=\linewidth]{{{src}}}"
+
         if key not in LATEX_RULES:
             if node.kind in {"admonition", "details"}:
                 # escaped_title = "".join(

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

@@ -112,7 +112,7 @@ def _compile_to_svg(latex_body: str) -> bytes:
 
         p = subprocess.run(
             # ["pdf2svg", str(td / "x.pdf"), str(td / "x.svg")],
-            ["dvisvgm", "--bbox=min", "--pdf", str(td / "x.pdf"), "-o", str(td / "x.svg")],
+            ["dvisvgm", "--no-fonts", "--bbox=min", "--pdf", str(td / "x.pdf"), "-o", str(td / "x.svg")],
             cwd=td,
             stdout=subprocess.PIPE,
             stderr=subprocess.STDOUT,

{gradientgrove-0.1.3.dev1 → gradientgrove-0.1.5}/src/gradientgrove/markdown_ast.py

@@ -69,6 +69,9 @@ REVEALJS_TEMPLATE = Template("""<!doctype html>
                              
   .reveal .slides section {
     text-align: left;
+    height: 100%;
+    overflow-y: auto;
+    overflow-x: auto;
   }
 
   .reveal .slides section h1,
@@ -263,15 +266,6 @@ HTML_HEADER_TEMPLATE = Template(r"""<!doctype html>
     </style>
     <style><!-- https://github.com/sindresorhus/github-markdown-css -->
     </style> 
-    <style>
-    /* Optional: center like GitHub / VS Code preview */
-    .markdown-body {
-    box-sizing: border-box;
-    min-width: 200px;
-    max-width: 980px;
-    margin: 0 auto;
-    padding: 32px;
-    }</style>
 </head>
 <body class="markdown-body">
     $html_body
@@ -342,6 +336,7 @@ showstringspaces=false,
 \setlength{\parindent}{0pt}
 \usepackage{longtable}
 \usepackage{booktabs}
+\newcounter{none}
 \newcommand{\tightlist}{}
 \usetheme{Madrid}
 \usepackage{multicol}
@@ -356,6 +351,7 @@ showstringspaces=false,
 }
 \title{$title}
 \author{$author}
+$dateline
 \begin{document}
 \begin{frame}
 \maketitle
@@ -365,6 +361,7 @@ showstringspaces=false,
 ARTICLE_HEADER_TEMPLATE = Template(r"""
 \documentclass{article}
 \usepackage{beamerarticle}
+\usepackage[margin=1in,top=0.5in,bottom=0.5in, paperwidth=8.5in, paperheight=11in]{geometry}
 \usepackage{tikz}
 \usetikzlibrary{shapes.geometric} 
 \usetikzlibrary{shadings}
@@ -426,19 +423,26 @@ breaklines=true,
 keepspaces=true,
 showstringspaces=false,
 }
-\setlength{\parindent}{0pt}
-\setlength{\parskip}{0.6\baselineskip}
+%\setlength{\parindent}{0pt}
+%\setlength{\parskip}{0.6\baselineskip}
+\usepackage{parskip}
+% format tables
 \usepackage{longtable}
 \usepackage{booktabs}
+%\setlength{\tabcolsep}{0.5em} % for the horizontal padding
+\renewcommand{\arraystretch}{1.2}% for the vertical padding
+\newcounter{none}
+%
 \newcommand{\tightlist}{}
 \usepackage[most]{tcolorbox}
 \BeforeBeginEnvironment{frame}{\begin{tcolorbox}[enhanced,breakable,boxrule=0.6pt,colback=white,colframe=black,arc=6pt,left=6pt,right=6pt,top=6pt,bottom=6pt,]}
 \AfterEndEnvironment{frame}{\end{tcolorbox}}
 \title{$title}
 \author{$author}
+$dateline
 \begin{document}
 \maketitle
-\tableofcontents
+%\tableofcontents
 """.strip())
 
 # ------------------------------------------------------------
@@ -915,6 +919,13 @@ class SyntaxTree:
 
         protected_text = "\n".join(protected_lines)
 
+        # Convert \newpage to !!! newpage
+        protected_text = re.sub(
+            r"\\newpage\b",
+            "\n\n!!! newpage\n\n",
+            protected_text,
+        )
+
         # Strip out latex commands with on markdown analog
         strip_latex_commands = ["alert", "only", "onslide"]
         for command in strip_latex_commands:
@@ -1039,6 +1050,18 @@ class SyntaxTree:
         )
         # print("length of text after strip comments", len(text))
 
+        # Capture document metadata, store as yaml
+        pandoc_md = subprocess.run(
+            ["pandoc", "-f", "latex", "-t", "markdown", "-s"],
+            input=text,
+            text=True,
+            capture_output=True,
+            check=True,
+        ).stdout
+        yaml = re.match(r"---\n.*?\n---\n", pandoc_md, re.S)
+        yaml = yaml.group(0) if yaml else ""
+
+
         if "\\begin{document}" in text:
             text = text.split("\\begin{document}", 1)[1]
 
@@ -1083,8 +1106,8 @@ class SyntaxTree:
             extensions=extensions,
             extension_configs=extension_configs,
         )
-        tree.markdown_text = markdown_text
-
+        # tree.markdown_text = markdown_text
+        tree.markdown_text = yaml + "\n" + markdown_text # Store yaml metadata
         
 
         return tree
@@ -1097,9 +1120,10 @@ class SyntaxTree:
         heading_names = {"h1", "h2", "h3", "h4", "h5", "h6"}
 
         if self.name in heading_names and not in_document_root:
-            raise ValueError(
-                f"Heading {self.name!r} must be top-level in the document"
-            )
+            # raise ValueError(
+            #     f"Heading {self.name!r} must be top-level in the document"
+            # )
+            print(f"Warning: Heading {self.name!r} with title {self.text!r} must be top-level in the document")
 
         if self.name == "frame":
             for child in self.children:
@@ -1597,6 +1621,7 @@ class SyntaxTree:
         *,
         title="Document",
         author="Stephen Flood",
+        date=None,
         beamer=False,
         omit_envs=None,
         transparent_envs=None,
@@ -1618,6 +1643,9 @@ class SyntaxTree:
 
             body = self._render_latex(omit_envs, transparent_envs, progress=progress)
 
+        # Define date parameter
+        dateline = rf"\date{{{date}}}" if date else ""
+
         if beamer:
             template = BEAMER_HEADER_TEMPLATE
         else:

{gradientgrove-0.1.3.dev1 → gradientgrove-0.1.5}/src/gradientgrove/markdown_publish.py

@@ -1,4 +1,4 @@
-from gradientgrove.markdown_ast import SyntaxTree
+from gradientgrove.markdown_ast import SyntaxTree, latex_to_markdown_main
 from gradientgrove import latex_fence
 
 import argparse
@@ -6,6 +6,10 @@ import base64
 import mimetypes
 import subprocess
 import sys
+import shutil 
+
+# import yaml # mkdocs already depends on `pyyaml`
+from mkdocs.utils.meta import get_data
 
 from mkdocs.commands.build import get_files
 from mkdocs.config import load_config
@@ -23,6 +27,8 @@ DEFAULT_EXTENSIONS = [
     "sane_lists",
     "admonition",
     "attr_list",
+    "def_list",
+    "footnotes",
     "pymdownx.arithmatex",
     "pymdownx.details",
     "pymdownx.superfences",
@@ -90,9 +96,15 @@ def compile_latex(filename):
         # stderr=subprocess.STDOUT,
     )
     if result.returncode != 0:
-        print(f"Compile failed: {filename}")
-        print(result.stdout)
-        return False
+        pdf = filename.with_suffix(".pdf")
+        if not pdf.exists():
+            print(f"Compile failed: {filename}")
+            print(result.stdout)
+            return False
+        else:
+            print(f"Compile succeded with errors: {filename}")
+            print(result.stdout)
+            return True
     return True
 
 def resolve_local_image_paths(tree, markdown_parent):
@@ -109,7 +121,8 @@ def resolve_local_image_paths(tree, markdown_parent):
 
         resolved = (markdown_parent / src).resolve()
         if resolved.exists():
-            node.attrs["src"] = str(resolved)
+            # node.attrs["src"] = str(resolved)
+            node.attrs["src"] = resolved.as_posix()
 
 
 def embed_local_images(tree, markdown_parent):
@@ -178,15 +191,28 @@ def convert_mkdocs_directory(path, output_directory, *, page_zip=True, **options
     nav = get_navigation(files, config)
     pages = [page for page in nav.pages if page.file.src_uri.endswith(".md")]
 
+    site_title = config['site_name']
+    site_title = re.sub(r'[^A-Za-z0-9 -_]', '', site_title)
+    site_title = re.sub(r'[ -]+', '_', site_title)
+    site_title_md = site_title + ".md"
+    site_title_zip = site_title + ".zip"
+
     generated = []
-    merged_file = output_directory / "mkdocs-merged.md"
+    # merged_file = output_directory / "mkdocs-merged.md"
+    merged_file = output_directory / site_title_md
     try:
         merged = "\n\n".join(
             Path(page.file.abs_src_path).read_text(encoding="utf-8")
             for page in pages
         )
         merged_file.write_text(merged, encoding="utf-8")
-        generated.extend(convert_file(merged_file, output_directory, **options, package_zip=False))
+        generated.extend(
+            convert_file(
+                merged_file, output_directory, 
+                    image_base=Path(config.docs_dir),
+                    **options, package_zip=False,
+                )
+            )
     finally:
         merged_file.unlink(missing_ok=True)
 
@@ -195,28 +221,49 @@ def convert_mkdocs_directory(path, output_directory, *, page_zip=True, **options
             page_source = Path(page.file.abs_src_path)
             page_output_directory = output_directory / Path(page.file.src_uri).with_suffix("").parent
             page_output_directory.mkdir(parents=True, exist_ok=True)
-            generated.extend(convert_file(page_source, page_output_directory, **options, package_zip=False))
+            generated.extend(
+                convert_file(page_source, page_output_directory, 
+                        image_base=Path(config.docs_dir),
+                        **options, package_zip=False
+                    )
+                )
 
     version = options.get("version", "")
-    zip_name = f"mkdocs-{version}.zip" if version else "mkdocs.zip"
+    # zip_name = f"mkdocs-{version}.zip" if version else "mkdocs.zip"
+    zip_name = f"{site_title_zip}-{version}.zip" if version else site_title_zip
     package_outputs(output_directory / zip_name, generated, base_directory=output_directory)
     return generated
 
-def convert_file(filename, output_directory, *, base=False, tex=False, revealjs=False,beamer=False, handout=False, tex_handout=False, version="", package_zip=True):
+def convert_file(filename, output_directory, *, 
+                 base=False, tex=False, revealjs=False,beamer=False, handout=False, tex_handout=False, 
+                 version="", package_zip=True,
+                 image_base=None,
+    ):
     tex_generated = []
     generated = []
     version_str = f"-{version}" if version else ""
 
+    image_base = image_base or filename.parent
+
     page_name = filename.stem
-    title = re.sub(r"[_-]+", " ", page_name).title()
+    default_title = re.sub(r"[_-]+", " ", page_name).title()
 
     # text = Path(filename).read_text(encoding="utf-8")
     text = filename.read_text(encoding="utf-8")
 
+    # Extract metadata, separate from body
+    text, meta = get_data(text) 
+    title = meta.get("title", default_title)
+    author = meta.get("author", "Stephen Flood")
+    if isinstance(author, list):
+        author = ", ".join(author)
+    date = meta.get("date", "")
+
     if base:
         tree = build_tree(text, number=True, render_latex_fences=True)
-        embed_local_images(tree, filename.parent)
-        variant=version_str+"-base"
+        embed_local_images(tree, image_base)
+        # variant=version_str+"-base"
+        variant = version_str
 
         output = tree.to_html(title=title)
         output_file = output_directory / f"{page_name}{variant}.html"
@@ -226,7 +273,7 @@ def convert_file(filename, output_directory, *, base=False, tex=False, revealjs=
 
     if handout:
         tree = build_tree(text, omit_envs=["answer"], number=True, render_latex_fences=True)
-        embed_local_images(tree, filename.parent)
+        embed_local_images(tree, image_base)
         
         variant=version_str+"-handout"
 
@@ -238,7 +285,7 @@ def convert_file(filename, output_directory, *, base=False, tex=False, revealjs=
 
     if revealjs:
         tree = build_tree(text, number=True, render_latex_fences=True)
-        embed_local_images(tree, filename.parent)
+        embed_local_images(tree, image_base)
         variant=version_str+"-revealjs"
 
         output = tree.to_revealjs(title=title)
@@ -250,11 +297,14 @@ def convert_file(filename, output_directory, *, base=False, tex=False, revealjs=
 
     if tex:
         tree = build_tree(text, number=False, render_latex_fences=False)
-        resolve_local_image_paths(tree, filename.parent)
-        variant=version_str+"-base"
+        resolve_local_image_paths(tree,  image_base)
+        # variant=version_str+"-base"
+        variant = version_str
         output = tree.to_latex(
             title=title,
-            author="Stephen Flood",
+            # author="Stephen Flood",
+            author=author,
+            date=date,
             beamer=False,
         )
 
@@ -262,11 +312,13 @@ def convert_file(filename, output_directory, *, base=False, tex=False, revealjs=
         output_file.write_text(output, encoding="utf-8")
 
         tex_generated.append(output_file)
-        generated.append(output_file)
+        
+        # Do/don't include tex in zip 
+        # generated.append(output_file)
 
     if tex_handout:
         tree = build_tree(text, number=False, omit_envs = ["answer"], render_latex_fences=False)
-        resolve_local_image_paths(tree, filename.parent)
+        resolve_local_image_paths(tree, image_base)
         variant=version_str+"-handout"
         output = tree.to_latex(
             title=title,
@@ -278,11 +330,13 @@ def convert_file(filename, output_directory, *, base=False, tex=False, revealjs=
         output_file.write_text(output, encoding="utf-8")
         # output = output_latex_article(filename,output_directory,variant=version_str+"-base")
         tex_generated.append(output_file)
-        generated.append(output_file)
+
+        # Do/don't include tex in zip 
+        # generated.append(output_file)
 
     if beamer:
         tree = build_tree(text, number=False, render_latex_fences=False)
-        resolve_local_image_paths(tree, filename.parent)
+        resolve_local_image_paths(tree,  image_base)
         variant=version_str+"-slides"
         output = tree.to_latex(
             title=title,
@@ -294,7 +348,9 @@ def convert_file(filename, output_directory, *, base=False, tex=False, revealjs=
         output_file.write_text(output, encoding="utf-8")
         # output = output_latex_article(filename,output_directory,variant=version_str+"-base")
         tex_generated.append(output_file)
-        generated.append(output_file)
+
+        # Do/don't include tex in zip 
+        # generated.append(output_file)
 
     # Compile LaTeX output
     for output in tex_generated:
@@ -341,14 +397,15 @@ def main():
     parser.add_argument("--revealjs", action="store_true", help="Generate revealjs slides")
     parser.add_argument("--html", action="store_true", help="Generate *all* HTML documents")
     parser.add_argument("--tex", action="store_true", help="Generate TeX base document")
-    parser.add_argument("--tex_handout", action="store_true", help="Generate TeX handout")
+    parser.add_argument("--pdf", action="store_true", help="Generate TeX base document")
+    parser.add_argument("--pdf-handout", action="store_true", help="Generate TeX handout")
     parser.add_argument("--beamer", action="store_true", help="Generate Beamer slides")
     parser.add_argument("--all", action="store_true", help="Generate all outputs")
     parser.add_argument(
         "--mkdocs-page-zip",
         dest="mkdocs_page_zip",
         action="store_true",
-        default=True,
+        default=False,
         help="In MkDocs mode, include each source page's outputs in the single .publish_cache/mkdocs.zip package (default)",
     )
     parser.add_argument(
@@ -370,10 +427,12 @@ def main():
 
     options = {
         "base" : args.base or args.all or args.html,
-        "handout" : args.all or args.html or args.handout,
-        "revealjs" : args.all or args.html or args.revealjs,    
-        "tex" : args.all or args.tex,
-        "tex_handout" : args.all or args.tex_handout ,
+        # "handout" : args.all or args.html or args.handout,
+        # "revealjs" : args.all or args.html or args.revealjs, 
+        "handout" : args.all or args.handout,
+        "revealjs" : args.all or args.revealjs,   
+        "tex" : args.all or args.tex or args.pdf,
+        "tex_handout" : args.all or args.pdf_handout ,
         "beamer" : args.all or args.beamer ,
         "version" : args.version,
     }
@@ -388,14 +447,25 @@ def main():
         convert_mkdocs_directory(path, output_directory, page_zip=args.mkdocs_page_zip, **options)
 
     elif path.is_file():
+        tex_directory = path.parent
         output_directory = path.parent / ".publish_cache"
         output_directory.mkdir(parents=True, exist_ok=True)
+        
         print(f"Got a file: {path}")
-        convert_file(
+
+        if path.suffix.lower() == ".tex":
+            markdown_path = output_directory / path.with_suffix(".md").name
+            latex_to_markdown_main([str(path), str(markdown_path)])
+            path = markdown_path
+
+        generated = convert_file(
             path,
             output_directory,
             **options
         )
+        # copy any generated PDFs back into the tex file directory. 
+        for pdf in (p for p in generated if p.suffix == ".pdf"):
+            shutil.copy2(pdf, tex_directory)
 
     elif path.is_dir():
         output_directory = path / ".publish_cache"

gradientgrove-0.1.5/src/gradientgrove/publish.py

@@ -0,0 +1,4 @@
+from .markdown_publish import main
+
+if __name__ == "__main__":
+    main()

gradientgrove-0.1.3.dev1/README.md → gradientgrove-0.1.5/src/gradientgrove.egg-info/PKG-INFO

@@ -1,3 +1,21 @@
+Metadata-Version: 2.4
+Name: gradientgrove
+Version: 0.1.5
+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
+Project-URL: Homepage, https://gradientgrove.com
+Project-URL: Issues, https://gradientgrove.com
+Classifier: Programming Language :: Python :: 3
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: markdown
+Requires-Dist: mkdocs
+Requires-Dist: pymdown-extensions
+Dynamic: license-file
+
 # gradientgrove
 
 Local Python scripts for reusable Markdown, LaTeX, and publishing workflows.
@@ -14,10 +32,84 @@ gradientgrove-latex-to-markdown --help
 After installation, setuptools exposes the console scripts shown above. When running from a source checkout instead of an installed package, use the equivalent module form and prefix commands with `PYTHONPATH=src`:
 
 ```bash
-PYTHONPATH=src python -m gradientgrove.markdown_publish --help
+PYTHONPATH=src python -m gradientgrove.publish --help
 PYTHONPATH=src python -m gradientgrove.markdown_ast --help
 ```
 
+## Markdown Syntax
+
+- Standard Mkdocs/python-markdown syntax
+- Several additional fences, with behavior dependent on output format
+    - Contents of `frame` become slides in revealjs/beamer output.  Contents of `pause` are revealed when advancing. 
+    - A page break is inserted before and after the contents of `page`
+    - A `newpage` environment with no contents inserts a pagebreak. 
+- You cannot put (sub)*section divisions inside a `frame`
+
+| environment | article (html/pdf) | slides (revealjs/beamer) | 
+| ------- | ------ | ------ | 
+| `frame`, `pause` | ignored | yes | 
+| `newpage`, `page`, `vspace`, `vfill` | yes | ignored | 
+| `exercise`, `answer` | yes | yes | 
+| `theorem`, `definition` | yes | yes | 
+
+```
+---
+title : "My Document"
+author: "Firstname Lastname"
+---
+
+# Background
+
+!!! note 
+    Standard MkDocs/Python Markdown admonitions work
+
+??? info
+    Collapsable admonitions work too
+
+# Slideshows
+
+!!! frame "Frame Title"
+
+    Frame contents go here
+
+    !!! pause
+        Displayed when advanced
+    
+!!! exercise
+    You can put exercises between frames
+
+??? answer
+    And you can put answers too. 
+
+    Answers are **excluded** from handout mode
+
+!!! frame
+    You can put the next frame here
+
+!!! page
+    !!! exercise 
+        You can also make a worksheet with spaces
+    
+    !!! vfill
+
+    !!! exercise
+        Another exercise
+    
+    !!! vfill
+
+# Mathematics environments
+
+!!! definition 
+    Definitions work
+
+!!! theorem
+    Theorems too
+
+Currently supported environments are hardcoded into the template, particularly for latex output.
+Eventually there should be a more dynamic solution. 
+```
+
+
 ## Publishing Markdown documents
 
 `gradientgrove.markdown_publish` converts Markdown files into HTML, Reveal.js slides, LaTeX articles, LaTeX handouts, and Beamer slides.

{gradientgrove-0.1.3.dev1 → gradientgrove-0.1.5}/src/gradientgrove.egg-info/SOURCES.txt

@@ -7,8 +7,10 @@ src/gradientgrove/latex_fast_renderer.py
 src/gradientgrove/latex_fence.py
 src/gradientgrove/markdown_ast.py
 src/gradientgrove/markdown_publish.py
+src/gradientgrove/publish.py
 src/gradientgrove.egg-info/PKG-INFO
 src/gradientgrove.egg-info/SOURCES.txt
 src/gradientgrove.egg-info/dependency_links.txt
 src/gradientgrove.egg-info/entry_points.txt
+src/gradientgrove.egg-info/requires.txt
 src/gradientgrove.egg-info/top_level.txt

{gradientgrove-0.1.3.dev1 → gradientgrove-0.1.5}/src/gradientgrove.egg-info/entry_points.txt

@@ -1,4 +1,3 @@
 [console_scripts]
 gradientgrove-latex-to-markdown = gradientgrove.markdown_ast:latex_to_markdown_main
-gradientgrove-pdf-review = gradientgrove.pdf_review_tool:main
 gradientgrove-publish = gradientgrove.markdown_publish:main

gradientgrove-0.1.5/src/gradientgrove.egg-info/requires.txt

@@ -0,0 +1,3 @@
+markdown
+mkdocs
+pymdown-extensions