mkdocs-entangled-plugin 0.2.0__tar.gz → 0.4.0__tar.gz

{mkdocs_entangled_plugin-0.2.0 → mkdocs_entangled_plugin-0.4.0}/PKG-INFO

@@ -1,24 +1,25 @@
 Metadata-Version: 2.1
 Name: mkdocs-entangled-plugin
-Version: 0.2.0
+Version: 0.4.0
 Summary: Plugin for MkDocs helping with rendering Entangled (entangled.github.io) projects.
 License: Apache 2.0
 Author: Johan Hidding
 Author-email: j.hidding@esciencecenter.nl
-Requires-Python: >=3.7
+Requires-Python: >=3.11,<4.0
 Classifier: License :: Other/Proprietary License
 Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.7
-Classifier: Programming Language :: Python :: 3.8
-Classifier: Programming Language :: Python :: 3.9
-Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
+Requires-Dist: entangled-cli (>=2.0.0a6,<3.0.0)
+Requires-Dist: mawk (>=0.1.4,<0.2.0)
 Requires-Dist: mkdocs (>=1.4.2,<2.0.0)
 Description-Content-Type: text/markdown
 
 # Welcome to MkDocs Entangled Plugin
 Using this plugin, you can make your Entangled documents look better.
 
+## Examples
+Detailed examples are found in the [entangled/mkdocs-examples repository](https://entangled.github.io/mkdocs-examples).
+
 ## Install
 
 Install this with `pip install mkdocs-entangled-plugin`. To use the entangled plugin, add the following lines to your `mkdocs.yml`:
@@ -33,11 +34,19 @@ markdown_extensions:
       alternate_style: true 
 ```
 
-## Annotates codeblocks
+For more information, see [the documentation](https://entangled.github.io/mkdocs-plugin).
+
+## Components
+This plugin bundles functionality for literate programming with Entangled.
+
+- Annotate code blocks with titles.
+- Build artifacts using Make.
+
+### Annotate code blocks
 The default markdown syntax that Entangled supports has fenced code blocks as follows
 
 ~~~markdown
-``` {.python file=hello_world.py}
+``` {.python file=examples/hello_world.py}
 if __name__ == "__main__":
     <<hello-world>>
 ```
@@ -45,7 +54,7 @@ if __name__ == "__main__":
 
 Which renders like this:
 
-``` {.python file=hello_world.py}
+``` {.python file=examples/hello_world.py}
 if __name__ == "__main__":
     <<hello-world>>
 ```
@@ -61,10 +70,10 @@ print("Hello, World!")
 that render like this:
 
 ``` {.python #hello-world}
-print("Hello, World!")
+print("Hello, Universe!")
 ```
 
-## Build Artifacts
+### Build Artifacts
 
 Build artifacts by specifying a Makefile.
 
@@ -73,14 +82,18 @@ Build artifacts by specifying a Makefile.
 
     ![](fig/plot.svg)
 
-=== "Makefile"
+=== "Source"
+
+    ``` {.gnuplot file=examples/plot.gp}
+    # enter your plotting commands here
+    ```
 
     ``` {.make .build-artifact}
     .RECIPEPREFIX = >
   
-    docs/fig/plot.svg:
+    docs/fig/plot.svg: examples/plot.gp
     > mkdir -p $(@D)
-    > gnuplot -e "set term svg; plot sin(x)" > $@
+    > gnuplot $^ > $@
     ```
 ~~~
 
@@ -88,14 +101,26 @@ Build artifacts by specifying a Makefile.
 
     ![](fig/plot.svg)
 
-=== "Makefile"
+=== "Source"
+
+    ``` {.gnuplot file=examples/plot.gp}
+    set term svg background rgb 'white' size 700, 500
+    sinc(r) = sin(pi*r) / (pi*r)
+    set isosamples 50, 50
+    set hidden3d
+    set xrange [-4:4]
+    set yrange [-4:4]
+    set xyplane 0
+    set title "Sinc function"
+    splot sinc(sqrt(x**2 + y**2)) t'' lc rgb '#5533cc'
+    ```
 
     ``` {.make .build-artifact}
     .RECIPEPREFIX = >
   
-    docs/fig/plot.svg:
+    docs/fig/plot.svg: examples/plot.gp
     > mkdir -p $(@D)
-    > gnuplot -e "set term svg; plot sin(x)" > $@
+    > gnuplot $^ > $@
     ```
 
 ## License

{mkdocs_entangled_plugin-0.2.0 → mkdocs_entangled_plugin-0.4.0}/README.md

@@ -1,6 +1,9 @@
 # Welcome to MkDocs Entangled Plugin
 Using this plugin, you can make your Entangled documents look better.
 
+## Examples
+Detailed examples are found in the [entangled/mkdocs-examples repository](https://entangled.github.io/mkdocs-examples).
+
 ## Install
 
 Install this with `pip install mkdocs-entangled-plugin`. To use the entangled plugin, add the following lines to your `mkdocs.yml`:
@@ -15,11 +18,19 @@ markdown_extensions:
       alternate_style: true 
 ```
 
-## Annotates codeblocks
+For more information, see [the documentation](https://entangled.github.io/mkdocs-plugin).
+
+## Components
+This plugin bundles functionality for literate programming with Entangled.
+
+- Annotate code blocks with titles.
+- Build artifacts using Make.
+
+### Annotate code blocks
 The default markdown syntax that Entangled supports has fenced code blocks as follows
 
 ~~~markdown
-``` {.python file=hello_world.py}
+``` {.python file=examples/hello_world.py}
 if __name__ == "__main__":
     <<hello-world>>
 ```
@@ -27,7 +38,7 @@ if __name__ == "__main__":
 
 Which renders like this:
 
-``` {.python file=hello_world.py}
+``` {.python file=examples/hello_world.py}
 if __name__ == "__main__":
     <<hello-world>>
 ```
@@ -43,10 +54,10 @@ print("Hello, World!")
 that render like this:
 
 ``` {.python #hello-world}
-print("Hello, World!")
+print("Hello, Universe!")
 ```
 
-## Build Artifacts
+### Build Artifacts
 
 Build artifacts by specifying a Makefile.
 
@@ -55,14 +66,18 @@ Build artifacts by specifying a Makefile.
 
     ![](fig/plot.svg)
 
-=== "Makefile"
+=== "Source"
+
+    ``` {.gnuplot file=examples/plot.gp}
+    # enter your plotting commands here
+    ```
 
     ``` {.make .build-artifact}
     .RECIPEPREFIX = >
   
-    docs/fig/plot.svg:
+    docs/fig/plot.svg: examples/plot.gp
     > mkdir -p $(@D)
-    > gnuplot -e "set term svg; plot sin(x)" > $@
+    > gnuplot $^ > $@
     ```
 ~~~
 
@@ -70,14 +85,26 @@ Build artifacts by specifying a Makefile.
 
     ![](fig/plot.svg)
 
-=== "Makefile"
+=== "Source"
+
+    ``` {.gnuplot file=examples/plot.gp}
+    set term svg background rgb 'white' size 700, 500
+    sinc(r) = sin(pi*r) / (pi*r)
+    set isosamples 50, 50
+    set hidden3d
+    set xrange [-4:4]
+    set yrange [-4:4]
+    set xyplane 0
+    set title "Sinc function"
+    splot sinc(sqrt(x**2 + y**2)) t'' lc rgb '#5533cc'
+    ```
 
     ``` {.make .build-artifact}
     .RECIPEPREFIX = >
   
-    docs/fig/plot.svg:
+    docs/fig/plot.svg: examples/plot.gp
     > mkdir -p $(@D)
-    > gnuplot -e "set term svg; plot sin(x)" > $@
+    > gnuplot $^ > $@
     ```
 
 ## License

{mkdocs_entangled_plugin-0.2.0 → mkdocs_entangled_plugin-0.4.0}/mkdocs_entangled/on_page_markdown.py

@@ -1,26 +1,18 @@
 from typing import Optional
 from dataclasses import dataclass
-from pathlib import Path
 import re
-import tempfile
-import subprocess
-import sys
 
 from mkdocs.config.defaults import MkDocsConfig
 from mkdocs.structure.pages import Page
 from mkdocs.structure.files import Files
 
-from .config import EntangledConfig
-from .properties import read_properties, Id, Attribute, Class
-from . import mawk
+from .properties import read_properties, Id, Attribute
+import mawk
 
 
 @dataclass
 class EntangledFilter(mawk.RuleSet):
     add_title: bool = True
-    build_artifacts: bool = True
-
-    _collect_make_script: bool = False
     _ignore: bool = False
 
     @mawk.on_match(r"~~~markdown")
@@ -58,31 +50,11 @@ class EntangledFilter(mawk.RuleSet):
             if title is not None:
                 props.append(Attribute("title", title))
         
-        if self.build_artifacts and Class("build-artifact") in props:
-            self._collect_make_script = True
-            self._make_script: list[str] = []
-            self._make_props = props
-            self._indent = indent
-
         prop_str = " ".join(str(p) for p in props)
         return [f"{indent}``` {{{prop_str}}}"]
 
     @mawk.on_match(r"\s*```\s*$")
     def close_code_block(self, m: re.Match) -> Optional[list[str]]:
-        if not self._ignore and self._collect_make_script:
-            self._collect_make_script = False
-            script = "\n".join(self._make_script)
-            with tempfile.TemporaryDirectory() as _tmpdir:
-                tmpdir = Path(_tmpdir)
-                with open(tmpdir / "Makefile", "w") as makefile:
-                    makefile.write(script)
-                subprocess.run(["make", "-f", str(tmpdir / "Makefile")])
-        return None
-
-    @mawk.always
-    def add_line_to_script(self, line: str) -> Optional[list[str]]:
-        if not self._ignore and self._collect_make_script:
-            self._make_script.append(line.removeprefix(self._indent))
         return None
 
 

{mkdocs_entangled_plugin-0.2.0 → mkdocs_entangled_plugin-0.4.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "mkdocs-entangled-plugin"
-version = "0.2.0"
+version = "0.4.0"
 description = "Plugin for MkDocs helping with rendering Entangled (entangled.github.io) projects."
 readme = "README.md"
 authors = ["Johan Hidding <j.hidding@esciencecenter.nl>"]
@@ -13,8 +13,10 @@ packages = [
 entangled = "mkdocs_entangled:EntangledPlugin"
 
 [tool.poetry.dependencies]
-python = ">=3.7"
+python = "^3.11"
 mkdocs = "^1.4.2"
+entangled-cli = "^2.0.0a6"
+mawk = "^0.1.4"
 
 [tool.poetry.dev-dependencies]
 mypy = "^1.2.0"

mkdocs_entangled_plugin-0.2.0/mkdocs_entangled/mawk.py

@@ -1,100 +0,0 @@
-"""
-μAwk, a tiny awk-like interface in Python
-"""
-
-from typing import Callable, Optional
-from functools import wraps, partial
-import re
-
-
-"""Global counter to sort filters by the order in which they appear
-in a class."""
-_filter_creation_order = 0
-
-
-def match_filter(expr: str, handler: Callable[[re.Match], Optional[list[str]]], inp: str) -> Optional[list[str]]:
-    if m := re.match(expr, inp):
-        return handler(m)
-    return None
-
-
-def on_match(expr: str):
-    """Decorator for doing search-and-replace based on a given regex.
-    
-    The inner function should take as argument a `re.Match` object
-    and return a list of strings. The resulting decorated function
-    then becomes a function from string to list of strings.
-    
-    If the input doesn't match the given regex, the original string
-    is returned.
-    
-    The inner function may still decide to do nothing by returning None.
-    
-    To erase the matched input return the empty list.
-
-    This decorator also works on class methods. It is then assumed that
-    the method has signature `(self, m: re.Match)`.
-    """
-    def _decorator(f):
-        global _filter_creation_order
-        method = len(f.__qualname__.split('.')) > 1
-        if method:
-            @wraps(f)
-            def _impl(self, inp):
-                return match_filter(expr, partial(f, self), inp)
-            _impl._is_rule = _filter_creation_order  # add tag to method
-            _filter_creation_order += 1
-            return _impl
-        else:
-            return wraps(f)(partial(match_filter, expr, f))
-    return _decorator
-
-
-def always(f):
-    """Suppose you have a rule with `@on_match(r".*")`, then it is better
-    not to run the regex machinery at all and just pass on the string.
-    In that case it is better to use `@always`."""
-    global _filter_creation_order
-    method = len(f.__qualname__.split('.')) > 1
-    if method:
-        f._is_rule = _filter_creation_order  # add tag to method
-        _filter_creation_order += 1
-        return f
-    else:
-        return f
-
-
-Rule = Callable[[str], list[str]]
-
-
-def run(rules: list[Rule], inp: str, exclusive=True) -> str:
-    """Takes a list of rules, being function from `str` to `list[str]`.
-    The input string is split into lines, after which each line is fed
-    through the list of rules. All the results are colected into a list
-    of strings and then joined by newline.
-    """
-    lines = inp.splitlines()
-    result = []
-    for l in lines:
-        for r in rules:
-            v = r(l)
-            if v is not None:
-                result.extend(v)
-                if exclusive:
-                    break
-        else:
-            result.append(l)
-    return "\n".join(result)
-
-
-class RuleSet:
-    """To be used as a base class for classes that contain `on_match`
-    decorated methods."""
-    def list_rules(self):
-        members = (getattr(self, m) for m in dir(self) if m[0] != '_')
-        rules = [m for m in members if hasattr(m, '_is_rule')]
-        return sorted(rules, key=lambda r: r._is_rule)
-
-    def run(self, inp: str, exclusive=True) -> str:
-        """Runs all rules in the class on input."""
-        return run(self.list_rules(), inp, exclusive)