markdown-exec 1.10.4__tar.gz → 1.12.0__tar.gz
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- {markdown_exec-1.10.4 → markdown_exec-1.12.0}/CHANGELOG.md +16 -0
- {markdown_exec-1.10.4 → markdown_exec-1.12.0}/PKG-INFO +16 -7
- {markdown_exec-1.10.4 → markdown_exec-1.12.0}/README.md +14 -4
- {markdown_exec-1.10.4 → markdown_exec-1.12.0}/config/pytest.ini +2 -0
- {markdown_exec-1.10.4 → markdown_exec-1.12.0}/docs/.overrides/main.html +5 -7
- {markdown_exec-1.10.4 → markdown_exec-1.12.0}/docs/snippets/gallery/argparse.py +1 -1
- {markdown_exec-1.10.4 → markdown_exec-1.12.0}/docs/snippets/gallery/argparse_format.py +1 -1
- {markdown_exec-1.10.4 → markdown_exec-1.12.0}/docs/snippets/gallery/d2.py +0 -4
- {markdown_exec-1.10.4 → markdown_exec-1.12.0}/docs/snippets/gallery/runpy.py +4 -4
- {markdown_exec-1.10.4 → markdown_exec-1.12.0}/docs/usage/index.md +8 -0
- {markdown_exec-1.10.4 → markdown_exec-1.12.0}/docs/usage/pyodide.md +50 -2
- {markdown_exec-1.10.4 → markdown_exec-1.12.0}/docs/usage/tree.md +53 -1
- {markdown_exec-1.10.4 → markdown_exec-1.12.0}/duties.py +21 -64
- {markdown_exec-1.10.4 → markdown_exec-1.12.0}/mkdocs.yml +1 -11
- {markdown_exec-1.10.4 → markdown_exec-1.12.0}/pyproject.toml +2 -3
- {markdown_exec-1.10.4 → markdown_exec-1.12.0}/scripts/get_version.py +6 -1
- {markdown_exec-1.10.4 → markdown_exec-1.12.0}/scripts/make.py +48 -13
- {markdown_exec-1.10.4 → markdown_exec-1.12.0}/src/markdown_exec/_internal/debug.py +1 -1
- {markdown_exec-1.10.4 → markdown_exec-1.12.0}/src/markdown_exec/_internal/formatters/pyodide.py +29 -1
- {markdown_exec-1.10.4 → markdown_exec-1.12.0}/src/markdown_exec/_internal/formatters/sh.py +1 -0
- markdown_exec-1.12.0/src/markdown_exec/_internal/formatters/tree.py +163 -0
- {markdown_exec-1.10.4 → markdown_exec-1.12.0}/src/markdown_exec/_internal/main.py +8 -3
- {markdown_exec-1.10.4 → markdown_exec-1.12.0}/src/markdown_exec/assets/pyodide.css +0 -2
- {markdown_exec-1.10.4 → markdown_exec-1.12.0}/src/markdown_exec/assets/pyodide.js +15 -1
- {markdown_exec-1.10.4 → markdown_exec-1.12.0}/tests/test_api.py +4 -2
- {markdown_exec-1.10.4 → markdown_exec-1.12.0}/tests/test_base_formatter.py +2 -2
- markdown_exec-1.10.4/docs/css/insiders.css +0 -124
- markdown_exec-1.10.4/docs/insiders/changelog.md +0 -12
- markdown_exec-1.10.4/docs/insiders/goals.yml +0 -16
- markdown_exec-1.10.4/docs/insiders/index.md +0 -157
- markdown_exec-1.10.4/docs/insiders/installation.md +0 -67
- markdown_exec-1.10.4/docs/js/insiders.js +0 -74
- markdown_exec-1.10.4/scripts/insiders.py +0 -173
- markdown_exec-1.10.4/src/markdown_exec/_internal/formatters/tree.py +0 -60
- {markdown_exec-1.10.4 → markdown_exec-1.12.0}/CODE_OF_CONDUCT.md +0 -0
- {markdown_exec-1.10.4 → markdown_exec-1.12.0}/CONTRIBUTING.md +0 -0
- {markdown_exec-1.10.4 → markdown_exec-1.12.0}/LICENSE +0 -0
- {markdown_exec-1.10.4 → markdown_exec-1.12.0}/config/coverage.ini +0 -0
- {markdown_exec-1.10.4 → markdown_exec-1.12.0}/config/git-changelog.toml +0 -0
- {markdown_exec-1.10.4 → markdown_exec-1.12.0}/config/mypy.ini +0 -0
- {markdown_exec-1.10.4 → markdown_exec-1.12.0}/config/ruff.toml +0 -0
- {markdown_exec-1.10.4 → markdown_exec-1.12.0}/config/vscode/launch.json +0 -0
- {markdown_exec-1.10.4 → markdown_exec-1.12.0}/config/vscode/settings.json +0 -0
- {markdown_exec-1.10.4 → markdown_exec-1.12.0}/config/vscode/tasks.json +0 -0
- {markdown_exec-1.10.4 → markdown_exec-1.12.0}/docs/.overrides/partials/comments.html +0 -0
- {markdown_exec-1.10.4 → markdown_exec-1.12.0}/docs/.overrides/partials/path-item.html +0 -0
- {markdown_exec-1.10.4 → markdown_exec-1.12.0}/docs/changelog.md +0 -0
- {markdown_exec-1.10.4 → markdown_exec-1.12.0}/docs/code_of_conduct.md +0 -0
- {markdown_exec-1.10.4 → markdown_exec-1.12.0}/docs/contributing.md +0 -0
- {markdown_exec-1.10.4 → markdown_exec-1.12.0}/docs/credits.md +0 -0
- {markdown_exec-1.10.4 → markdown_exec-1.12.0}/docs/css/material.css +0 -0
- {markdown_exec-1.10.4 → markdown_exec-1.12.0}/docs/css/mkdocstrings.css +0 -0
- {markdown_exec-1.10.4 → markdown_exec-1.12.0}/docs/gallery.md +0 -0
- {markdown_exec-1.10.4 → markdown_exec-1.12.0}/docs/index.md +0 -0
- {markdown_exec-1.10.4 → markdown_exec-1.12.0}/docs/js/feedback.js +0 -0
- {markdown_exec-1.10.4 → markdown_exec-1.12.0}/docs/license.md +0 -0
- {markdown_exec-1.10.4 → markdown_exec-1.12.0}/docs/reference/api.md +0 -0
- {markdown_exec-1.10.4 → markdown_exec-1.12.0}/docs/schema.json +0 -0
- {markdown_exec-1.10.4 → markdown_exec-1.12.0}/docs/snippets/gallery/ansi.sh +0 -0
- {markdown_exec-1.10.4 → markdown_exec-1.12.0}/docs/snippets/gallery/chalk.py +0 -0
- {markdown_exec-1.10.4 → markdown_exec-1.12.0}/docs/snippets/gallery/diagrams.py +0 -0
- {markdown_exec-1.10.4 → markdown_exec-1.12.0}/docs/snippets/gallery/drawsvg.py +0 -0
- {markdown_exec-1.10.4 → markdown_exec-1.12.0}/docs/snippets/gallery/expandable_filetree.py +0 -0
- {markdown_exec-1.10.4 → markdown_exec-1.12.0}/docs/snippets/gallery/hyperbolic.py +0 -0
- {markdown_exec-1.10.4 → markdown_exec-1.12.0}/docs/snippets/gallery/matplotlib.py +0 -0
- {markdown_exec-1.10.4 → markdown_exec-1.12.0}/docs/snippets/gallery/plotly.py +0 -0
- {markdown_exec-1.10.4 → markdown_exec-1.12.0}/docs/snippets/gallery/pydeps.py +0 -0
- {markdown_exec-1.10.4 → markdown_exec-1.12.0}/docs/snippets/gallery/qrcode.py +0 -0
- {markdown_exec-1.10.4 → markdown_exec-1.12.0}/docs/snippets/gallery/rich.py +0 -0
- {markdown_exec-1.10.4 → markdown_exec-1.12.0}/docs/snippets/gallery/rich_terminal.py +0 -0
- {markdown_exec-1.10.4 → markdown_exec-1.12.0}/docs/snippets/gallery/textual.py +0 -0
- {markdown_exec-1.10.4 → markdown_exec-1.12.0}/docs/snippets/usage/boolean_matrix.py +0 -0
- {markdown_exec-1.10.4 → markdown_exec-1.12.0}/docs/snippets/usage/hide.py +0 -0
- {markdown_exec-1.10.4 → markdown_exec-1.12.0}/docs/snippets/usage/multiple.pycon +0 -0
- {markdown_exec-1.10.4 → markdown_exec-1.12.0}/docs/snippets/usage/platform_html.py +0 -0
- {markdown_exec-1.10.4 → markdown_exec-1.12.0}/docs/snippets/usage/platform_md.py +0 -0
- {markdown_exec-1.10.4 → markdown_exec-1.12.0}/docs/snippets/usage/source.py +0 -0
- {markdown_exec-1.10.4 → markdown_exec-1.12.0}/docs/snippets/usage/source.pycon +0 -0
- {markdown_exec-1.10.4 → markdown_exec-1.12.0}/docs/usage/python.md +0 -0
- {markdown_exec-1.10.4 → markdown_exec-1.12.0}/docs/usage/shell.md +0 -0
- {markdown_exec-1.10.4 → markdown_exec-1.12.0}/scripts/gen_credits.py +0 -0
- {markdown_exec-1.10.4 → markdown_exec-1.12.0}/scripts/make +0 -0
- {markdown_exec-1.10.4 → markdown_exec-1.12.0}/src/markdown_exec/__init__.py +0 -0
- {markdown_exec-1.10.4 → markdown_exec-1.12.0}/src/markdown_exec/_internal/__init__.py +0 -0
- {markdown_exec-1.10.4 → markdown_exec-1.12.0}/src/markdown_exec/_internal/formatters/__init__.py +0 -0
- {markdown_exec-1.10.4 → markdown_exec-1.12.0}/src/markdown_exec/_internal/formatters/_exec_python.py +0 -0
- {markdown_exec-1.10.4 → markdown_exec-1.12.0}/src/markdown_exec/_internal/formatters/base.py +0 -0
- {markdown_exec-1.10.4 → markdown_exec-1.12.0}/src/markdown_exec/_internal/formatters/bash.py +0 -0
- {markdown_exec-1.10.4 → markdown_exec-1.12.0}/src/markdown_exec/_internal/formatters/console.py +0 -0
- {markdown_exec-1.10.4 → markdown_exec-1.12.0}/src/markdown_exec/_internal/formatters/markdown.py +0 -0
- {markdown_exec-1.10.4 → markdown_exec-1.12.0}/src/markdown_exec/_internal/formatters/pycon.py +0 -0
- {markdown_exec-1.10.4 → markdown_exec-1.12.0}/src/markdown_exec/_internal/formatters/python.py +0 -0
- {markdown_exec-1.10.4 → markdown_exec-1.12.0}/src/markdown_exec/_internal/logger.py +0 -0
- {markdown_exec-1.10.4 → markdown_exec-1.12.0}/src/markdown_exec/_internal/mkdocs_plugin.py +0 -0
- {markdown_exec-1.10.4 → markdown_exec-1.12.0}/src/markdown_exec/_internal/processors.py +0 -0
- {markdown_exec-1.10.4 → markdown_exec-1.12.0}/src/markdown_exec/_internal/rendering.py +0 -0
- {markdown_exec-1.10.4 → markdown_exec-1.12.0}/src/markdown_exec/assets/ansi.css +0 -0
- {markdown_exec-1.10.4 → markdown_exec-1.12.0}/src/markdown_exec/formatters/__init__.py +0 -0
- {markdown_exec-1.10.4 → markdown_exec-1.12.0}/src/markdown_exec/formatters/base.py +0 -0
- {markdown_exec-1.10.4 → markdown_exec-1.12.0}/src/markdown_exec/formatters/bash.py +0 -0
- {markdown_exec-1.10.4 → markdown_exec-1.12.0}/src/markdown_exec/formatters/console.py +0 -0
- {markdown_exec-1.10.4 → markdown_exec-1.12.0}/src/markdown_exec/formatters/markdown.py +0 -0
- {markdown_exec-1.10.4 → markdown_exec-1.12.0}/src/markdown_exec/formatters/pycon.py +0 -0
- {markdown_exec-1.10.4 → markdown_exec-1.12.0}/src/markdown_exec/formatters/pyodide.py +0 -0
- {markdown_exec-1.10.4 → markdown_exec-1.12.0}/src/markdown_exec/formatters/python.py +0 -0
- {markdown_exec-1.10.4 → markdown_exec-1.12.0}/src/markdown_exec/formatters/sh.py +0 -0
- {markdown_exec-1.10.4 → markdown_exec-1.12.0}/src/markdown_exec/formatters/tree.py +0 -0
- {markdown_exec-1.10.4 → markdown_exec-1.12.0}/src/markdown_exec/logger.py +0 -0
- {markdown_exec-1.10.4 → markdown_exec-1.12.0}/src/markdown_exec/mkdocs_plugin.py +0 -0
- {markdown_exec-1.10.4 → markdown_exec-1.12.0}/src/markdown_exec/processors.py +0 -0
- {markdown_exec-1.10.4 → markdown_exec-1.12.0}/src/markdown_exec/py.typed +0 -0
- {markdown_exec-1.10.4 → markdown_exec-1.12.0}/src/markdown_exec/rendering.py +0 -0
- {markdown_exec-1.10.4 → markdown_exec-1.12.0}/tests/__init__.py +0 -0
- {markdown_exec-1.10.4 → markdown_exec-1.12.0}/tests/conftest.py +0 -0
- {markdown_exec-1.10.4 → markdown_exec-1.12.0}/tests/test_converter.py +0 -0
- {markdown_exec-1.10.4 → markdown_exec-1.12.0}/tests/test_headings.py +0 -0
- {markdown_exec-1.10.4 → markdown_exec-1.12.0}/tests/test_python.py +0 -0
- {markdown_exec-1.10.4 → markdown_exec-1.12.0}/tests/test_shell.py +0 -0
- {markdown_exec-1.10.4 → markdown_exec-1.12.0}/tests/test_toc.py +0 -0
- {markdown_exec-1.10.4 → markdown_exec-1.12.0}/tests/test_tree.py +0 -0
- {markdown_exec-1.10.4 → markdown_exec-1.12.0}/tests/test_validator.py +0 -0
|
@@ -5,6 +5,22 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
|
|
|
5
5
|
and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
|
|
6
6
|
|
|
7
7
|
<!-- insertion marker -->
|
|
8
|
+
## [1.12.0](https://github.com/pawamoy/markdown-exec/releases/tag/1.12.0) - 2025-11-10
|
|
9
|
+
|
|
10
|
+
<small>[Compare with 1.11.0](https://github.com/pawamoy/markdown-exec/compare/1.11.0...1.12.0)</small>
|
|
11
|
+
|
|
12
|
+
### Features
|
|
13
|
+
|
|
14
|
+
- Support per-file-extension icons ([e6e0d59](https://github.com/pawamoy/markdown-exec/commit/e6e0d59904dff70920e72290ce19adacb720b0c6) by Timothée Mazzucotelli).
|
|
15
|
+
|
|
16
|
+
## [1.11.0](https://github.com/pawamoy/markdown-exec/releases/tag/1.11.0) - 2025-06-28
|
|
17
|
+
|
|
18
|
+
<small>[Compare with 1.10.4](https://github.com/pawamoy/markdown-exec/compare/1.10.4...1.11.0)</small>
|
|
19
|
+
|
|
20
|
+
### Features
|
|
21
|
+
|
|
22
|
+
- Add option to set height of Pyodide/Ace editors ([c64a2ef](https://github.com/pawamoy/markdown-exec/commit/c64a2efd8cb7a7a691039e866dab5839f8ef8bfe) by Jayant Pranjal). [Issue-41](https://github.com/pawamoy/markdown-exec/issues/41), Co-authored-by: Jayant <jayant@Jayants-MacBook-Air.local>, Co-authored-by: Timothée Mazzucotelli <dev@pawamoy.fr>
|
|
23
|
+
|
|
8
24
|
## [1.10.4](https://github.com/pawamoy/markdown-exec/releases/tag/1.10.4) - 2025-06-27
|
|
9
25
|
|
|
10
26
|
<small>[Compare with 1.10.3](https://github.com/pawamoy/markdown-exec/compare/1.10.3...1.10.4)</small>
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
Metadata-Version: 2.4
|
|
2
2
|
Name: markdown-exec
|
|
3
|
-
Version: 1.
|
|
3
|
+
Version: 1.12.0
|
|
4
4
|
Summary: Utilities to execute code blocks in Markdown files.
|
|
5
5
|
Keywords: markdown,python,exec,shell,bash,mkdocs
|
|
6
6
|
Author-Email: =?utf-8?q?Timoth=C3=A9e_Mazzucotelli?= <dev@pawamoy.fr>
|
|
@@ -11,7 +11,6 @@ Classifier: Intended Audience :: Developers
|
|
|
11
11
|
Classifier: Programming Language :: Python
|
|
12
12
|
Classifier: Programming Language :: Python :: 3
|
|
13
13
|
Classifier: Programming Language :: Python :: 3 :: Only
|
|
14
|
-
Classifier: Programming Language :: Python :: 3.9
|
|
15
14
|
Classifier: Programming Language :: Python :: 3.10
|
|
16
15
|
Classifier: Programming Language :: Python :: 3.11
|
|
17
16
|
Classifier: Programming Language :: Python :: 3.12
|
|
@@ -29,7 +28,7 @@ Project-URL: Issues, https://github.com/pawamoy/markdown-exec/issues
|
|
|
29
28
|
Project-URL: Discussions, https://github.com/pawamoy/markdown-exec/discussions
|
|
30
29
|
Project-URL: Gitter, https://gitter.im/markdown-exec/community
|
|
31
30
|
Project-URL: Funding, https://github.com/sponsors/pawamoy
|
|
32
|
-
Requires-Python: >=3.
|
|
31
|
+
Requires-Python: >=3.10
|
|
33
32
|
Requires-Dist: pymdown-extensions>=9
|
|
34
33
|
Provides-Extra: ansi
|
|
35
34
|
Requires-Dist: pygments-ansi-color>=0.3; extra == "ansi"
|
|
@@ -40,7 +39,8 @@ Description-Content-Type: text/markdown
|
|
|
40
39
|
[](https://github.com/pawamoy/markdown-exec/actions?query=workflow%3Aci)
|
|
41
40
|
[](https://pawamoy.github.io/markdown-exec/)
|
|
42
41
|
[](https://pypi.org/project/markdown-exec/)
|
|
43
|
-
[](https://app.gitter.im/#/room/#markdown-exec:gitter.im)
|
|
43
|
+
[](https://app.radicle.at/nodes/seed.radicle.at/rad:z77aiLJkzYXtuNpZuvizfGkDuZbQ)
|
|
44
44
|
|
|
45
45
|
Utilities to execute code blocks in Markdown files.
|
|
46
46
|
|
|
@@ -83,7 +83,7 @@ Markdown(
|
|
|
83
83
|
"format": formatter,
|
|
84
84
|
}
|
|
85
85
|
# ...one fence for each language we support:
|
|
86
|
-
# bash, console, md, markdown, py, python, pycon, sh, tree
|
|
86
|
+
# bash, console, md, markdown, py, python, pycon, pyodide, sh, tree, etc.
|
|
87
87
|
]
|
|
88
88
|
}
|
|
89
89
|
}
|
|
@@ -118,9 +118,13 @@ markdown_extensions:
|
|
|
118
118
|
- pymdownx.superfences
|
|
119
119
|
```
|
|
120
120
|
|
|
121
|
-
We
|
|
121
|
+
TIP: We recommend enabling Markdown Exec with the MkDocs plugin
|
|
122
122
|
if you are using MkDocs: it will take care of adding relevant
|
|
123
|
-
assets (CSS/JS) to the final site when needed.
|
|
123
|
+
assets (CSS/JS) to the final site when needed.
|
|
124
|
+
|
|
125
|
+
WARNING: **Limitation of configuration through Markdown/PyMDown.**
|
|
126
|
+
Configuration through `pymdownx.superfences` directly is not well supported for fences that require assets inclusion, like `pyodide`.
|
|
127
|
+
For these you will have to include the assets manually. In the future we will provide ways to include them automatically.
|
|
124
128
|
|
|
125
129
|
## Usage
|
|
126
130
|
|
|
@@ -145,3 +149,8 @@ grep extra_css README.md && exit 2
|
|
|
145
149
|
|
|
146
150
|
See [usage](https://pawamoy.github.io/markdown-exec/usage/) for more details,
|
|
147
151
|
and the [gallery](https://pawamoy.github.io/markdown-exec/gallery/) for more examples!
|
|
152
|
+
|
|
153
|
+
## Sponsors
|
|
154
|
+
|
|
155
|
+
<!-- sponsors-start -->
|
|
156
|
+
<!-- sponsors-end -->
|
|
@@ -3,7 +3,8 @@
|
|
|
3
3
|
[](https://github.com/pawamoy/markdown-exec/actions?query=workflow%3Aci)
|
|
4
4
|
[](https://pawamoy.github.io/markdown-exec/)
|
|
5
5
|
[](https://pypi.org/project/markdown-exec/)
|
|
6
|
-
[](https://app.gitter.im/#/room/#markdown-exec:gitter.im)
|
|
7
|
+
[](https://app.radicle.at/nodes/seed.radicle.at/rad:z77aiLJkzYXtuNpZuvizfGkDuZbQ)
|
|
7
8
|
|
|
8
9
|
Utilities to execute code blocks in Markdown files.
|
|
9
10
|
|
|
@@ -46,7 +47,7 @@ Markdown(
|
|
|
46
47
|
"format": formatter,
|
|
47
48
|
}
|
|
48
49
|
# ...one fence for each language we support:
|
|
49
|
-
# bash, console, md, markdown, py, python, pycon, sh, tree
|
|
50
|
+
# bash, console, md, markdown, py, python, pycon, pyodide, sh, tree, etc.
|
|
50
51
|
]
|
|
51
52
|
}
|
|
52
53
|
}
|
|
@@ -81,9 +82,13 @@ markdown_extensions:
|
|
|
81
82
|
- pymdownx.superfences
|
|
82
83
|
```
|
|
83
84
|
|
|
84
|
-
We
|
|
85
|
+
TIP: We recommend enabling Markdown Exec with the MkDocs plugin
|
|
85
86
|
if you are using MkDocs: it will take care of adding relevant
|
|
86
|
-
assets (CSS/JS) to the final site when needed.
|
|
87
|
+
assets (CSS/JS) to the final site when needed.
|
|
88
|
+
|
|
89
|
+
WARNING: **Limitation of configuration through Markdown/PyMDown.**
|
|
90
|
+
Configuration through `pymdownx.superfences` directly is not well supported for fences that require assets inclusion, like `pyodide`.
|
|
91
|
+
For these you will have to include the assets manually. In the future we will provide ways to include them automatically.
|
|
87
92
|
|
|
88
93
|
## Usage
|
|
89
94
|
|
|
@@ -108,3 +113,8 @@ grep extra_css README.md && exit 2
|
|
|
108
113
|
|
|
109
114
|
See [usage](https://pawamoy.github.io/markdown-exec/usage/) for more details,
|
|
110
115
|
and the [gallery](https://pawamoy.github.io/markdown-exec/gallery/) for more examples!
|
|
116
|
+
|
|
117
|
+
## Sponsors
|
|
118
|
+
|
|
119
|
+
<!-- sponsors-start -->
|
|
120
|
+
<!-- sponsors-end -->
|
|
@@ -1,13 +1,11 @@
|
|
|
1
1
|
{% extends "base.html" %}
|
|
2
2
|
|
|
3
3
|
{% block announce %}
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
</span> —
|
|
10
|
-
|
|
4
|
+
<strong>Fund this project</strong> through
|
|
5
|
+
<a href="https://github.com/sponsors/pawamoy"><strong>sponsorship</strong></a>
|
|
6
|
+
<span class="twemoji heart pulse">
|
|
7
|
+
{% include ".icons/octicons/heart-fill-16.svg" %}
|
|
8
|
+
</span> —
|
|
11
9
|
Follow
|
|
12
10
|
<strong>@pawamoy</strong> on
|
|
13
11
|
<a rel="me" href="https://fosstodon.org/@pawamoy">
|
|
@@ -6,13 +6,13 @@ from runpy import run_module
|
|
|
6
6
|
|
|
7
7
|
old_argv = list(sys.argv)
|
|
8
8
|
sys.argv = ["mkdocs"]
|
|
9
|
-
|
|
10
|
-
sys.
|
|
9
|
+
old_stderr = sys.stderr
|
|
10
|
+
sys.stderr = StringIO()
|
|
11
11
|
warnings.filterwarnings("ignore", category=RuntimeWarning)
|
|
12
12
|
with suppress(SystemExit):
|
|
13
13
|
run_module("mkdocs", run_name="__main__")
|
|
14
|
-
output = sys.
|
|
15
|
-
sys.
|
|
14
|
+
output = sys.stderr.getvalue()
|
|
15
|
+
sys.stderr = old_stderr
|
|
16
16
|
sys.argv = old_argv
|
|
17
17
|
|
|
18
18
|
print(f"```\n{output}\n```")
|
|
@@ -271,6 +271,14 @@ $ cat .git/config
|
|
|
271
271
|
```
|
|
272
272
|
````
|
|
273
273
|
|
|
274
|
+
If you just want a basic code block without any syntax highlighting, use the `text` language:
|
|
275
|
+
|
|
276
|
+
````md exec="1" source="tabbed-left" tabs="Markdown|Rendered"
|
|
277
|
+
```console exec="1" result="text"
|
|
278
|
+
$ echo 'print("some python code that is not highlighted")'
|
|
279
|
+
```
|
|
280
|
+
````
|
|
281
|
+
|
|
274
282
|
WARNING: **Limitation:**
|
|
275
283
|
Wrapping the result is not possible when HTML output is enabled.
|
|
276
284
|
|
|
@@ -1,7 +1,5 @@
|
|
|
1
1
|
# Pyodide
|
|
2
2
|
|
|
3
|
-
[:octicons-tag-24: Insiders 1.0.0](../insiders/changelog.md#1.0.0)
|
|
4
|
-
|
|
5
3
|
This special `pyodide` fence uses [Pyodide](https://pyodide.org), [Ace](https://ace.c9.io/)
|
|
6
4
|
and [Highlight.js](https://highlightjs.org/) to render an interactive Python editor.
|
|
7
5
|
Everything runs on the client side. The first time Pyodide is loaded by the browser
|
|
@@ -45,6 +43,56 @@ print("Hello.")
|
|
|
45
43
|
|
|
46
44
|
NOTE: **All Pyodide blocks on the same page should use the same version!**
|
|
47
45
|
|
|
46
|
+
## Editor height
|
|
47
|
+
|
|
48
|
+
The height of the editor can be configured with the `height` option. It accepts the following values:
|
|
49
|
+
|
|
50
|
+
- `0` or `auto`: A fixed number of lines, based on initial code.
|
|
51
|
+
- a positive number, like `10`: A fixed number of lines.
|
|
52
|
+
- a positive range, like `5-30`: The minimum and maximum number of lines. The editor will shring/grow as you type.
|
|
53
|
+
|
|
54
|
+
The default is `auto`.
|
|
55
|
+
|
|
56
|
+
A few examples:
|
|
57
|
+
|
|
58
|
+
````md exec="1" source="tabbed-left" tabs="Markdown|Rendered" title="Fixed height (10 lines)"
|
|
59
|
+
```pyodide height="10"
|
|
60
|
+
from typing import Iterator
|
|
61
|
+
|
|
62
|
+
# This is an example
|
|
63
|
+
class Math:
|
|
64
|
+
@staticmethod
|
|
65
|
+
def fib(n: int) -> Iterator[int]:
|
|
66
|
+
"""Fibonacci series up to n."""
|
|
67
|
+
a, b = 0, 1
|
|
68
|
+
while a < n:
|
|
69
|
+
yield a
|
|
70
|
+
a, b = b, a + b
|
|
71
|
+
|
|
72
|
+
result = sum(Math.fib(42))
|
|
73
|
+
print(f"The answer is {result}")
|
|
74
|
+
```
|
|
75
|
+
````
|
|
76
|
+
|
|
77
|
+
````md exec="1" source="tabbed-left" tabs="Markdown|Rendered" title="Between 1 and 40 lines"
|
|
78
|
+
```pyodide height="1-40"
|
|
79
|
+
from typing import Iterator
|
|
80
|
+
|
|
81
|
+
# This is an example
|
|
82
|
+
class Math:
|
|
83
|
+
@staticmethod
|
|
84
|
+
def fib(n: int) -> Iterator[int]:
|
|
85
|
+
"""Fibonacci series up to n."""
|
|
86
|
+
a, b = 0, 1
|
|
87
|
+
while a < n:
|
|
88
|
+
yield a
|
|
89
|
+
a, b = b, a + b
|
|
90
|
+
|
|
91
|
+
result = sum(Math.fib(42))
|
|
92
|
+
print(f"The answer is {result}")
|
|
93
|
+
```
|
|
94
|
+
````
|
|
95
|
+
|
|
48
96
|
## Sessions
|
|
49
97
|
|
|
50
98
|
Editors with the same session share the same `globals()` dictionary,
|
|
@@ -19,6 +19,8 @@ root2
|
|
|
19
19
|
```
|
|
20
20
|
````
|
|
21
21
|
|
|
22
|
+
## Syntax highlight
|
|
23
|
+
|
|
22
24
|
By default, the language used for syntax highlight is `bash`.
|
|
23
25
|
It means you can add comments with `#`:
|
|
24
26
|
|
|
@@ -56,6 +58,8 @@ root2
|
|
|
56
58
|
```
|
|
57
59
|
````
|
|
58
60
|
|
|
61
|
+
## Leaf directories
|
|
62
|
+
|
|
59
63
|
You can force an entry to be displayed as a directory instead of a regular file
|
|
60
64
|
by appending a trailing slash to the name:
|
|
61
65
|
|
|
@@ -68,7 +72,55 @@ root1
|
|
|
68
72
|
```
|
|
69
73
|
````
|
|
70
74
|
|
|
71
|
-
It is recommended to always append trailing slashes to
|
|
75
|
+
It is recommended to always append trailing slashes to directories anyway.
|
|
72
76
|
|
|
73
77
|
WARNING: **Limitation:**
|
|
74
78
|
Spaces in file names are not supported when searching for a trailing slash.
|
|
79
|
+
|
|
80
|
+
## Custom icons
|
|
81
|
+
|
|
82
|
+
Custom icons based on the file name and extension can be used in tree fences.
|
|
83
|
+
This feature requires that the [Material for MkDocs](https://squidfunk.github.io/mkdocs-material/) theme is used.
|
|
84
|
+
By default, if Material for MkDocs is used, custom icons will be rendered.
|
|
85
|
+
You can opt-out with `icons="basic"` to use the basic folder and file emojis,
|
|
86
|
+
or even remove all icons/emojis with `icons="none"`.
|
|
87
|
+
|
|
88
|
+
````md exec="1" source="tabbed-left" tabs="Markdown|Rendered"
|
|
89
|
+
```tree icons="none"
|
|
90
|
+
folder/
|
|
91
|
+
file
|
|
92
|
+
file.py
|
|
93
|
+
file.rb
|
|
94
|
+
file.js
|
|
95
|
+
```
|
|
96
|
+
````
|
|
97
|
+
|
|
98
|
+
````md exec="1" source="tabbed-left" tabs="Markdown|Rendered"
|
|
99
|
+
```tree icons="basic"
|
|
100
|
+
folder/
|
|
101
|
+
file
|
|
102
|
+
file.py
|
|
103
|
+
file.rb
|
|
104
|
+
file.rs
|
|
105
|
+
```
|
|
106
|
+
````
|
|
107
|
+
|
|
108
|
+
````md exec="1" source="tabbed-left" tabs="Markdown|Rendered"
|
|
109
|
+
```tree icons="material"
|
|
110
|
+
folder/
|
|
111
|
+
file
|
|
112
|
+
file.py
|
|
113
|
+
file.rb
|
|
114
|
+
file.rs
|
|
115
|
+
```
|
|
116
|
+
````
|
|
117
|
+
|
|
118
|
+
````md exec="1" source="tabbed-left" tabs="Markdown|Rendered"
|
|
119
|
+
```tree icons="auto"
|
|
120
|
+
folder/
|
|
121
|
+
file
|
|
122
|
+
file.py
|
|
123
|
+
file.rb
|
|
124
|
+
file.rs
|
|
125
|
+
```
|
|
126
|
+
````
|
|
@@ -6,17 +6,16 @@ import os
|
|
|
6
6
|
import re
|
|
7
7
|
import sys
|
|
8
8
|
from contextlib import contextmanager
|
|
9
|
-
from functools import wraps
|
|
10
9
|
from importlib.metadata import version as pkgversion
|
|
11
10
|
from pathlib import Path
|
|
12
|
-
from typing import TYPE_CHECKING
|
|
11
|
+
from typing import TYPE_CHECKING
|
|
13
12
|
|
|
14
13
|
from duty import duty, tools
|
|
15
14
|
|
|
16
15
|
if TYPE_CHECKING:
|
|
17
16
|
from collections.abc import Iterator
|
|
18
17
|
|
|
19
|
-
from duty
|
|
18
|
+
from duty import Context
|
|
20
19
|
|
|
21
20
|
|
|
22
21
|
PY_SRC_PATHS = (Path(_) for _ in ("src", "tests", "duties.py", "scripts"))
|
|
@@ -26,6 +25,8 @@ CI = os.environ.get("CI", "0") in {"1", "true", "yes", ""}
|
|
|
26
25
|
WINDOWS = os.name == "nt"
|
|
27
26
|
PTY = not WINDOWS and not CI
|
|
28
27
|
MULTIRUN = os.environ.get("MULTIRUN", "0") == "1"
|
|
28
|
+
PY_VERSION = f"{sys.version_info.major}{sys.version_info.minor}"
|
|
29
|
+
PY_DEV = "314"
|
|
29
30
|
|
|
30
31
|
|
|
31
32
|
def pyprefix(title: str) -> str:
|
|
@@ -35,21 +36,6 @@ def pyprefix(title: str) -> str:
|
|
|
35
36
|
return title
|
|
36
37
|
|
|
37
38
|
|
|
38
|
-
def not_from_insiders(func: Callable) -> Callable:
|
|
39
|
-
@wraps(func)
|
|
40
|
-
def wrapper(ctx: Context, *args: Any, **kwargs: Any) -> None:
|
|
41
|
-
origin = ctx.run("git config --get remote.origin.url", silent=True)
|
|
42
|
-
if "pawamoy-insiders/griffe" in origin:
|
|
43
|
-
ctx.run(
|
|
44
|
-
lambda: False,
|
|
45
|
-
title="Not running this task from insiders repository (do that from public repo instead!)",
|
|
46
|
-
)
|
|
47
|
-
return
|
|
48
|
-
func(ctx, *args, **kwargs)
|
|
49
|
-
|
|
50
|
-
return wrapper
|
|
51
|
-
|
|
52
|
-
|
|
53
39
|
@contextmanager
|
|
54
40
|
def material_insiders() -> Iterator[bool]:
|
|
55
41
|
if "+insiders" in pkgversion("mkdocs-material"):
|
|
@@ -84,7 +70,7 @@ def check(ctx: Context) -> None:
|
|
|
84
70
|
"""Check it all!"""
|
|
85
71
|
|
|
86
72
|
|
|
87
|
-
@duty
|
|
73
|
+
@duty(nofail=PY_VERSION == PY_DEV)
|
|
88
74
|
def check_quality(ctx: Context) -> None:
|
|
89
75
|
"""Check the code quality."""
|
|
90
76
|
ctx.run(
|
|
@@ -93,7 +79,11 @@ def check_quality(ctx: Context) -> None:
|
|
|
93
79
|
)
|
|
94
80
|
|
|
95
81
|
|
|
96
|
-
@duty(
|
|
82
|
+
@duty(
|
|
83
|
+
skip_if=sys.version_info[:2] != (3, 12),
|
|
84
|
+
skip_reason=pyprefix("Docs build only on Python 3.12"),
|
|
85
|
+
nofail=PY_VERSION == PY_DEV,
|
|
86
|
+
)
|
|
97
87
|
def check_docs(ctx: Context) -> None:
|
|
98
88
|
"""Check if the documentation builds correctly."""
|
|
99
89
|
Path("htmlcov").mkdir(parents=True, exist_ok=True)
|
|
@@ -105,7 +95,7 @@ def check_docs(ctx: Context) -> None:
|
|
|
105
95
|
)
|
|
106
96
|
|
|
107
97
|
|
|
108
|
-
@duty
|
|
98
|
+
@duty(nofail=PY_VERSION == PY_DEV)
|
|
109
99
|
def check_types(ctx: Context) -> None:
|
|
110
100
|
"""Check that the code is correctly typed."""
|
|
111
101
|
os.environ["FORCE_COLOR"] = "1"
|
|
@@ -115,7 +105,7 @@ def check_types(ctx: Context) -> None:
|
|
|
115
105
|
)
|
|
116
106
|
|
|
117
107
|
|
|
118
|
-
@duty
|
|
108
|
+
@duty(nofail=PY_VERSION == PY_DEV)
|
|
119
109
|
def check_api(ctx: Context, *cli_args: str) -> None:
|
|
120
110
|
"""Check for API breaking changes."""
|
|
121
111
|
ctx.run(
|
|
@@ -142,39 +132,13 @@ def docs(ctx: Context, *cli_args: str, host: str = "127.0.0.1", port: int = 8000
|
|
|
142
132
|
|
|
143
133
|
|
|
144
134
|
@duty
|
|
145
|
-
def docs_deploy(ctx: Context
|
|
146
|
-
"""Deploy the documentation to GitHub pages.
|
|
147
|
-
|
|
148
|
-
Parameters:
|
|
149
|
-
force: Whether to force deployment, even from non-Insiders version.
|
|
150
|
-
"""
|
|
135
|
+
def docs_deploy(ctx: Context) -> None:
|
|
136
|
+
"""Deploy the documentation to GitHub pages."""
|
|
151
137
|
os.environ["DEPLOY"] = "true"
|
|
152
138
|
with material_insiders() as insiders:
|
|
153
139
|
if not insiders:
|
|
154
140
|
ctx.run(lambda: False, title="Not deploying docs without Material for MkDocs Insiders!")
|
|
155
|
-
|
|
156
|
-
if "pawamoy-insiders/markdown-exec" in origin:
|
|
157
|
-
ctx.run(
|
|
158
|
-
"git remote add upstream git@github.com:pawamoy/markdown-exec",
|
|
159
|
-
silent=True,
|
|
160
|
-
nofail=True,
|
|
161
|
-
allow_overrides=False,
|
|
162
|
-
)
|
|
163
|
-
ctx.run(
|
|
164
|
-
tools.mkdocs.gh_deploy(remote_name="upstream", force=True),
|
|
165
|
-
title="Deploying documentation",
|
|
166
|
-
)
|
|
167
|
-
elif force:
|
|
168
|
-
ctx.run(
|
|
169
|
-
tools.mkdocs.gh_deploy(force=True),
|
|
170
|
-
title="Deploying documentation",
|
|
171
|
-
)
|
|
172
|
-
else:
|
|
173
|
-
ctx.run(
|
|
174
|
-
lambda: False,
|
|
175
|
-
title="Not deploying docs from public repository (do that from insiders instead!)",
|
|
176
|
-
nofail=True,
|
|
177
|
-
)
|
|
141
|
+
ctx.run(tools.mkdocs.gh_deploy(force=True), title="Deploying documentation")
|
|
178
142
|
|
|
179
143
|
|
|
180
144
|
@duty
|
|
@@ -198,7 +162,6 @@ def build(ctx: Context) -> None:
|
|
|
198
162
|
|
|
199
163
|
|
|
200
164
|
@duty
|
|
201
|
-
@not_from_insiders
|
|
202
165
|
def publish(ctx: Context) -> None:
|
|
203
166
|
"""Publish source and wheel distributions to PyPI."""
|
|
204
167
|
if not Path("dist").exists():
|
|
@@ -212,7 +175,6 @@ def publish(ctx: Context) -> None:
|
|
|
212
175
|
|
|
213
176
|
|
|
214
177
|
@duty(post=["build", "publish", "docs-deploy"])
|
|
215
|
-
@not_from_insiders
|
|
216
178
|
def release(ctx: Context, version: str = "") -> None:
|
|
217
179
|
"""Release a new Python package.
|
|
218
180
|
|
|
@@ -223,7 +185,7 @@ def release(ctx: Context, version: str = "") -> None:
|
|
|
223
185
|
ctx.run("false", title="A version must be provided")
|
|
224
186
|
ctx.run("git add pyproject.toml CHANGELOG.md", title="Staging files", pty=PTY)
|
|
225
187
|
ctx.run(["git", "commit", "-m", f"chore: Prepare release {version}"], title="Committing changes", pty=PTY)
|
|
226
|
-
ctx.run(f"git tag {version}", title="Tagging commit", pty=PTY)
|
|
188
|
+
ctx.run(f"git tag -m '' -a {version}", title="Tagging commit", pty=PTY)
|
|
227
189
|
ctx.run("git push", title="Pushing commits", pty=False)
|
|
228
190
|
ctx.run("git push --tags", title="Pushing tags", pty=False)
|
|
229
191
|
|
|
@@ -236,20 +198,15 @@ def coverage(ctx: Context) -> None:
|
|
|
236
198
|
ctx.run(tools.coverage.html(rcfile="config/coverage.ini"))
|
|
237
199
|
|
|
238
200
|
|
|
239
|
-
@duty
|
|
240
|
-
def test(ctx: Context, *cli_args: str
|
|
241
|
-
"""Run the test suite.
|
|
242
|
-
|
|
243
|
-
|
|
244
|
-
match: A pytest expression to filter selected tests.
|
|
245
|
-
"""
|
|
246
|
-
py_version = f"{sys.version_info.major}{sys.version_info.minor}"
|
|
247
|
-
os.environ["COVERAGE_FILE"] = f".coverage.{py_version}"
|
|
201
|
+
@duty(nofail=PY_VERSION == PY_DEV)
|
|
202
|
+
def test(ctx: Context, *cli_args: str) -> None:
|
|
203
|
+
"""Run the test suite."""
|
|
204
|
+
os.environ["COVERAGE_FILE"] = f".coverage.{PY_VERSION}"
|
|
205
|
+
os.environ["PYTHONWARNDEFAULTENCODING"] = "1"
|
|
248
206
|
ctx.run(
|
|
249
207
|
tools.pytest(
|
|
250
208
|
"tests",
|
|
251
209
|
config_file="config/pytest.ini",
|
|
252
|
-
select=match,
|
|
253
210
|
color="yes",
|
|
254
211
|
).add_args("-n", "auto", *cli_args),
|
|
255
212
|
title=pyprefix("Running tests"),
|
|
@@ -31,11 +31,6 @@ nav:
|
|
|
31
31
|
- Contributing: contributing.md
|
|
32
32
|
- Code of Conduct: code_of_conduct.md
|
|
33
33
|
- Coverage report: coverage.md
|
|
34
|
-
- Insiders:
|
|
35
|
-
- insiders/index.md
|
|
36
|
-
- Getting started:
|
|
37
|
-
- Installation: insiders/installation.md
|
|
38
|
-
- Changelog: insiders/changelog.md
|
|
39
34
|
- Author's website: https://pawamoy.github.io/
|
|
40
35
|
|
|
41
36
|
theme:
|
|
@@ -83,7 +78,6 @@ theme:
|
|
|
83
78
|
extra_css:
|
|
84
79
|
- css/material.css
|
|
85
80
|
- css/mkdocstrings.css
|
|
86
|
-
- css/insiders.css
|
|
87
81
|
|
|
88
82
|
extra_javascript:
|
|
89
83
|
- js/feedback.js
|
|
@@ -148,7 +142,7 @@ plugins:
|
|
|
148
142
|
show_root_heading: true
|
|
149
143
|
show_root_full_path: false
|
|
150
144
|
show_signature_annotations: true
|
|
151
|
-
show_source:
|
|
145
|
+
show_source: true
|
|
152
146
|
show_symbol_type_heading: true
|
|
153
147
|
show_symbol_type_toc: true
|
|
154
148
|
signature_crossrefs: true
|
|
@@ -166,10 +160,6 @@ plugins:
|
|
|
166
160
|
type: timeago
|
|
167
161
|
- minify:
|
|
168
162
|
minify_html: !ENV [DEPLOY, false]
|
|
169
|
-
- group:
|
|
170
|
-
enabled: !ENV [MATERIAL_INSIDERS, false]
|
|
171
|
-
plugins:
|
|
172
|
-
- typeset
|
|
173
163
|
|
|
174
164
|
extra:
|
|
175
165
|
social:
|
|
@@ -15,7 +15,7 @@ license-files = [
|
|
|
15
15
|
"LICENSE",
|
|
16
16
|
]
|
|
17
17
|
readme = "README.md"
|
|
18
|
-
requires-python = ">=3.
|
|
18
|
+
requires-python = ">=3.10"
|
|
19
19
|
keywords = [
|
|
20
20
|
"markdown",
|
|
21
21
|
"python",
|
|
@@ -31,7 +31,6 @@ classifiers = [
|
|
|
31
31
|
"Programming Language :: Python",
|
|
32
32
|
"Programming Language :: Python :: 3",
|
|
33
33
|
"Programming Language :: Python :: 3 :: Only",
|
|
34
|
-
"Programming Language :: Python :: 3.9",
|
|
35
34
|
"Programming Language :: Python :: 3.10",
|
|
36
35
|
"Programming Language :: Python :: 3.11",
|
|
37
36
|
"Programming Language :: Python :: 3.12",
|
|
@@ -45,7 +44,7 @@ classifiers = [
|
|
|
45
44
|
dependencies = [
|
|
46
45
|
"pymdown-extensions>=9",
|
|
47
46
|
]
|
|
48
|
-
version = "1.
|
|
47
|
+
version = "1.12.0"
|
|
49
48
|
|
|
50
49
|
[project.optional-dependencies]
|
|
51
50
|
ansi = [
|
|
@@ -4,7 +4,12 @@ import re
|
|
|
4
4
|
from contextlib import suppress
|
|
5
5
|
from pathlib import Path
|
|
6
6
|
|
|
7
|
-
from pdm.backend.hooks.version import
|
|
7
|
+
from pdm.backend.hooks.version import ( # ty: ignore[unresolved-import]
|
|
8
|
+
SCMVersion,
|
|
9
|
+
Version,
|
|
10
|
+
default_version_formatter,
|
|
11
|
+
get_version_from_scm,
|
|
12
|
+
)
|
|
8
13
|
|
|
9
14
|
_root = Path(__file__).parent.parent
|
|
10
15
|
_changelog = _root / "CHANGELOG.md"
|