Release v0.5.10 (#36)

* Bump abatilo/actions-poetry from 2.1.6 to 2.3.0

Bumps [abatilo/actions-poetry](https://github.com/abatilo/actions-poetry) from 2.1.6 to 2.3.0.
- [Release notes](https://github.com/abatilo/actions-poetry/releases)
- [Changelog](https://github.com/abatilo/actions-poetry/blob/master/.releaserc)
- [Commits](abatilo/actions-poetry@v2.1.6...v2.3.0)

---
updated-dependencies:
- dependency-name: abatilo/actions-poetry
  dependency-type: direct:production
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <[email protected]>

* Bump mkdocstrings from 0.19.1 to 0.25.1

Bumps [mkdocstrings](https://github.com/mkdocstrings/mkdocstrings) from 0.19.1 to 0.25.1.
- [Release notes](https://github.com/mkdocstrings/mkdocstrings/releases)
- [Changelog](https://github.com/mkdocstrings/mkdocstrings/blob/main/CHANGELOG.md)
- [Commits](mkdocstrings/mkdocstrings@0.19.1...0.25.1)

---
updated-dependencies:
- dependency-name: mkdocstrings
  dependency-type: direct:development
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <[email protected]>

* (chore) lock update and update in CICD (#35)

* (chore) lock update and update in CICD
* (chore) updated preprocessor and added testing
* (chore) updated pre commit hooks and versions
* (chore) updated test to match boostrap distro, improved test error msg.
* (chore) upgraded missing versions of checkout and python setup in cicd

---------

Signed-off-by: dependabot[bot] <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

Author: jspaezp

.github/workflows/CICD.yml

@@ -12,10 +12,10 @@ jobs:
   cheap_checks:
     runs-on: 'ubuntu-latest'
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
 
       # Python setup
-      - uses: actions/setup-python@v4
+      - uses: actions/setup-python@v5
         with:
           python-version: '3.x'
 
@@ -39,7 +39,7 @@ jobs:
       - name: Black
         run: poetry run python -m black . --check --diff
       - name: ruff
-        run: poetry run ruff .
+        run: poetry run ruff check .
       - name: isort
         run: poetry run isort . --check
 
@@ -54,7 +54,7 @@ jobs:
     runs-on: ${{ matrix.os }}
     steps:
       # Initial Setup
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
 
       # Documentation setup
       - name: Setup Quarto
@@ -63,7 +63,7 @@ jobs:
         run: quarto --version
 
       # Python setup
-      - uses: actions/setup-python@v4
+      - uses: actions/setup-python@v5
         with:
           python-version: ${{ matrix.python-version }}
       - name: View Python --version
@@ -88,7 +88,7 @@ jobs:
       - name: mkdocs
         run: poetry run python -m mkdocs build --strict
 
-      - uses: codecov/codecov-action@v3
+      - uses: codecov/codecov-action@v4
         with:
           verbose: true # optional (default = false)
 
@@ -98,9 +98,9 @@ jobs:
     needs: ci
     if: endsWith(github.ref, 'heads/release') && (github.event_name == 'push')
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - name: Release
-        uses: softprops/action-gh-release@v1
+        uses: softprops/action-gh-release@v2
         if: startsWith(github.ref, 'refs/tags/')
 
       # Documentation setup
@@ -110,15 +110,15 @@ jobs:
         run: quarto --version
 
       # Python setup
-      - uses: actions/setup-python@v4
+      - uses: actions/setup-python@v5
         with:
           python-version: '3.x'
       - name: View Python --version
         run: python --version
 
       # Poetry Setup
       - name: Python Poetry Action
-        uses: abatilo/actions-poetry@v2.1.6
+        uses: abatilo/actions-poetry@v2.3.0
         with:
           poetry-version: '1.7.1'
       - name: View poetry --version

.github/workflows/lint.yml

@@ -6,10 +6,10 @@ jobs:
   lint:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - name: Black
         uses: psf/black@stable
       - name: Set up Python environment
-        uses: actions/setup-python@v4
+        uses: actions/setup-python@v5
         with:
           python-version: "3.9"

.pre-commit-config.yaml

@@ -10,20 +10,20 @@ repos:
         exclude: "(.*tests/data/.*/.*.md)"
       - id: debug-statements
   - repo: https://github.com/asottile/pyupgrade
-    rev: v3.15.2
+    rev: v3.17.0
     hooks:
       - id: pyupgrade
   - repo: https://github.com/PyCQA/autoflake
     rev: v2.3.1
     hooks:
       - id: autoflake
   - repo: https://github.com/psf/black
-    rev: 24.4.0
+    rev: 24.8.0
     hooks:
       - id: black
-        language_version: python3.8
+        language_version: python3.9
   - repo: https://github.com/charliermarsh/ruff-pre-commit
-    rev: v0.3.7
+    rev: v0.6.3
     hooks:
       - id: ruff
   - repo: https://github.com/pycqa/pydocstyle

docs/README.md

@@ -1,3 +1,6 @@
+---
+toc-title: Table of contents
+---
 
 ![Pypi
 version](https://img.shields.io/pypi/v/mkquartodocs?style=flat-square.png)
@@ -42,28 +45,32 @@ copying outpus.
 This will render code chunks and save the outputs! Check out
 https://quarto.org/ for more examples on how to use the format.
 
-This ….
+This ....
 
 ```` markdown
 
 ```{python}
-print(1+1)
+print(1+2)
 ```
 ````
 
-Will become this …
+Will become this ...
 
-``` python
-print(1+1)
+:::: {.cell execution_count="1"}
+``` {.python .cell-code}
+print(1+2)
 ```
 
-    2
+::: {.cell-output .cell-output-stdout}
+    3
+:::
+::::
 
 ## Installation
 
 1.  Make sure you have quarto installed in your computer.
 
-    - https://quarto.org/docs/get-started/
+    -   https://quarto.org/docs/get-started/
 
 2.  Install `mkquartodocs`
 
@@ -85,11 +92,11 @@ plugins:
 
 Available configuration options:
 
-- **quarto_path**: Specifies where to look for the quarto executable.
-- **keep_output**: If true it will skip the cleanup step in the
-  directory.
-- **ignore**: a python regular expressions that if matched will mark the
-  file to not be rendered. Note that they need to be full matches
+-   **quarto_path**: Specifies where to look for the quarto executable.
+-   **keep_output**: If true it will skip the cleanup step in the
+    directory.
+-   **ignore**: a python regular expressions that if matched will mark
+    the file to not be rendered. Note that they need to be full matches
 
 ``` yaml
 # Whatever is in your mkdocs.yml configuration file....
@@ -113,7 +120,10 @@ files, render them, generate the output and clean after itself.
 
 The things that need to/could be added to the project:
 
-- [ ] quarto project support
-- [ ] render in temporary directory, posibly with a ‘safe’ argument
-- [ ] addition of files not in the docs directory, ‘include’ argument
-- [ ] add readme to testing data
+-   [ ] quarto project support
+-   [ ] render in temporary directory, posibly with a 'safe' argument
+-   [ ] addition of files not in the docs directory, 'include' argument
+-   [ ] add readme to testing data
+-   [ ] move
+    `INFO     -  mkquartodocs: Running RemoveCellDataPreprocessor` to
+    debug log

docs/README.qmd

@@ -37,15 +37,15 @@ This ....
 ````
 
 ```{{python}}
-print(1+1)
+print(1+2)
 ```
 
 ````
 
 Will become this ...
 
 ```{python}
-print(1+1)
+print(1+2)
 ```
 
 ## Installation

mkquartodocs/extension.py

@@ -15,9 +15,9 @@
 
 class AdmotionCellDataPreprocessor(Preprocessor):
     CELL_REGEX: Final = re.compile(r"^::: \{\.cell .*}\s*$")
-    CELL_END: Final = re.compile(r"^:::$")
+    CELL_END: Final = re.compile(r"^:{3,4}?$")
     CELL_ELEM_REGEX: Final = re.compile(
-        r"^::: \{(.cell-\w+) (\.cell-[\w-]+)( execution_count=\"\d+\")?\}$"
+        r"^:{3,4} \{(\.cell(-\w+)?)\s?(\.cell-[\w-]+)?( execution_count=\"\d+\")?\}"
     )
     CODEBLOCK_REGEX: Final = re.compile(r"^```{\.(\w+) .*}")
 
@@ -34,7 +34,6 @@ def run(self, lines):
         outs = [self._process_line(x) for x in lines]
         log.debug(f"Removing {sum(1 for x in outs if x is None)} lines")
         out = [x for x in outs if x is not None]
-
         return out
 
     def _process_line(self, line):
@@ -47,12 +46,17 @@ def _process_line(self, line):
             out = "\n\n"
 
         elif sr := self.CELL_ELEM_REGEX.search(line):
-            log.debug(f"Matched Cell element: {line}")
-            output_type = sr.groups()[1]
-            out = self.TYPE_MAPPING[output_type]
+            groups = {i: x for i, x in enumerate(sr.groups())}
+            log.debug(f"Matched Cell element: {line}, groups: {groups}")
+            if groups[3]:
+                out = "\n\n"
+            else:
+                output_type = groups[2]
+                out = self.TYPE_MAPPING[output_type]
 
         elif sr := self.CODEBLOCK_REGEX.search(line):
-            log.debug(f"Matched codeblock: {line}")
+            groups = {i: x for i, x in enumerate(sr.groups())}
+            log.debug(f"Matched codeblock: {line} -> {groups}")
             lang = sr.groups(1)
             out = f"```{lang}"
         else:

mkquartodocs/plugin.py

@@ -85,10 +85,12 @@ def on_pre_build(self, config):
                             [quarto, "render", str(x), "--to=markdown"], check=True
                         )
                         break
-                    except subprocess.CalledProcessError:
+                    except subprocess.CalledProcessError as e:
                         # ERROR: Couldn't find open server
                         # it ocasionally fails with that error ...
                         if i == 4:
+                            log.error(f"Quarto failed to render {x} after 5 tries")
+                            log.error(f"Quarto failed with error: {e}")
                             raise
                         warnings.warn(f"Quarto failed to render {x}, retrying")
         else: