Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions docs/hooks/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
**/__pycache__
11 changes: 11 additions & 0 deletions docs/hooks/macros.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
import importlib.metadata


def define_env(env):
@env.macro
def requirements():
packages = dict()
for package in sorted(set(importlib.metadata.packages_distributions().keys())):
if package.startswith("numcodecs-wasm") or package.startswith("numcodecs_wasm"):
packages[package] = importlib.metadata.version(package)
return packages
3 changes: 2 additions & 1 deletion docs/requirements.txt
Original file line number Diff line number Diff line change
Expand Up @@ -28,10 +28,11 @@ properdocs
properdocs-theme-readthedocs

mkdocstrings[python]
mkdocs-exclude
mkdocs-include-markdown-plugin
mkdocs-gen-files
mkdocs-literate-nav
mkdocs-exclude
mkdocs-macros-plugin

Pygments

Expand Down
18 changes: 17 additions & 1 deletion docs/try-repl.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
---
render_macros: true
---

# Try the `numcodecs-wasm-*` codecs using JupyterLite

/// details | **Warning:** JupyterLite may not work in every web browser
Expand Down Expand Up @@ -34,6 +38,18 @@ plt.show()\
// example package lazy dependencies
"crc32c",
"msgpack",
]}));
]})) + "&pyodideKernelEnv=" + encodeURIComponent(JSON.stringify({"$override": {
"CLIMET_LAB_BOOTSTRAP_CODE": `\
def preinstall_packages(lines):
return """
import micropip
await micropip.install([
f"{package}=={version}" for package, version in {{ requirements() }}.items()
])
""".splitlines(keepends=True) + lines
preinstall_packages.has_side_effects = True
ip.input_transformers_cleanup.append(preinstall_packages)
`,
}}));
});
</script>
5 changes: 5 additions & 0 deletions properdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,11 @@ plugins:
- requirements.txt
- search
- autorefs
- macros:
module_name: docs/hooks/macros
on_error_fail: true
on_undefined: strict
render_by_default: false
- mkdocstrings:
enable_inventory: true
handlers:
Expand Down
Loading