From 4c0ae835d87140ff97760e4f521d02fae57f32f1 Mon Sep 17 00:00:00 2001 From: Andrea Zonca Date: Mon, 9 Dec 2024 19:42:00 +0000 Subject: [PATCH] doc: mkdocs-jupyter in requirements for docs --- mkdocs.yml | 6 +++++- overrides/main.html | 11 +++++++++++ pyproject.toml | 3 ++- 3 files changed, 18 insertions(+), 2 deletions(-) create mode 100644 overrides/main.html diff --git a/mkdocs.yml b/mkdocs.yml index 0673430..0f9a6a1 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -4,5 +4,9 @@ repo_url: https://github.com/det-lab/kaitai_struct_awkward_runtime edit_uri: edit/main/docs/ theme: name: material + custom_dir: overrides features: - - content.action.edit \ No newline at end of file + - content.action.edit +plugins: + - mkdocs-jupyter: + include_source: true \ No newline at end of file diff --git a/overrides/main.html b/overrides/main.html new file mode 100644 index 0000000..702c96b --- /dev/null +++ b/overrides/main.html @@ -0,0 +1,11 @@ +{% extends "base.html" %} + +{% block content %} +{% if page.nb_url %} + + {% include ".icons/material/download.svg" %} + +{% endif %} + +{{ super() }} +{% endblock content %} diff --git a/pyproject.toml b/pyproject.toml index aaf304b..68e80f0 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -45,7 +45,8 @@ dev = [ "pytest-cov >=3", ] docs = [ - "mkdocs-material" + "mkdocs-material", + "mkdocs-jupyter" ] [project.urls]