Help with debugging #4362
Answered
by
chrisdburr
chrisdburr
asked this question in
Q&A
Help with debugging
#4362
-
|
Is anyone able to help me figure out what's going wrong here? I'm trying to run I only noticed the issue after the latest update to Material, but I can't figure out if it's an incompatibility with the latest version of the Any help that can be offered would be greatly appreciated. |
Beta Was this translation helpful? Give feedback.
Answered by
chrisdburr
Sep 14, 2022
Replies: 2 comments 2 replies
-
|
And in case it helps, this is import glob
import os
import pathlib
import mkdocs
from mkdocs.config import config_options
from mkdocs.structure.files import File, Files
from mkdocs.structure.pages import Page
from mkdocs.structure.toc import get_toc
from mkdocs.tests.base import get_markdown_toc
from . import convert
class NotebookFile(File):
"""
Wraps a regular File object to make .ipynb files appear as
valid documentation files.
"""
def __init__(self, file, use_directory_urls, site_dir, **kwargs):
self.file = file
self.dest_path = self._get_dest_path(use_directory_urls)
self.abs_dest_path = os.path.normpath(
os.path.join(site_dir, self.dest_path)
)
self.url = self._get_url(use_directory_urls)
def __getattr__(self, item):
return self.file.__getattribute__(item) <--- this is the offending line 30
def is_documentation_page(self):
return True
class Plugin(mkdocs.plugins.BasePlugin):
config_scheme = (
("include", config_options.Type(list, default=["*.py", "*.ipynb"])),
("ignore", config_options.Type(list, default=[])),
("execute", config_options.Type(bool, default=False)),
("execute_ignore", config_options.Type(str, default="")),
("theme", config_options.Type(str, default="")),
("kernel_name", config_options.Type(str, default="")),
("include_source", config_options.Type(bool, default=False)),
("ignore_h1_titles", config_options.Type(bool, default=False)),
("allow_errors", config_options.Type(bool, default=True)),
)
_supported_extensions = [".ipynb", ".py"]
def should_include(self, file):
ext = os.path.splitext(str(file.abs_src_path))[-1]
if ext not in self._supported_extensions:
return False
srcpath = pathlib.PurePath(file.abs_src_path)
include = None
ignore = None
for pattern in self.config["ignore"]:
if srcpath.match(pattern):
ignore = True
for pattern in self.config["include"]:
if srcpath.match(pattern):
include = True
return include and not ignore
def on_files(self, files, config):
ret = Files(
[
NotebookFile(file, **config)
if self.should_include(file)
else file
for file in files
]
)
return ret
def on_pre_page(self, page, config, files):
if self.should_include(page.file):
ignore_h1_titles = self.config["ignore_h1_titles"]
kernel_name = self.config["kernel_name"]
exec_nb = self.config["execute"]
allow_errors = self.config["allow_errors"]
if self.config["execute_ignore"]:
ignore_pattern = self.config["execute_ignore"]
execute_ignore = pathlib.PurePath(
page.file.abs_src_path
).match(ignore_pattern)
if execute_ignore:
exec_nb = False
theme = self.config["theme"]
def new_render(self, config, files):
body = convert.nb2html(
page.file.abs_src_path,
execute=exec_nb,
kernel_name=kernel_name,
theme=theme,
allow_errors=allow_errors,
)
self.content = body
toc, title = get_nb_toc(page.file.abs_src_path)
self.toc = toc
if title is not None and not ignore_h1_titles:
self.title = title
# replace render with new_render for this object only
page.render = new_render.__get__(page, Page)
# Add metadata for template
self._set_nb_url(page)
return page
def _set_nb_url(self, page):
from urllib.parse import urljoin
nb_source = page.file.abs_src_path
nb_source_name = os.path.basename(nb_source)
page.nb_url = urljoin(page.abs_url, nb_source_name)
def on_post_page(self, output_content, page, config):
# Include source
if self.config["include_source"]:
from shutil import copyfile
nb_source = page.file.abs_src_path
nb_source_name = os.path.basename(nb_source)
nb_target_dir = os.path.dirname(page.file.abs_dest_path)
nb_target = os.path.join(nb_target_dir, nb_source_name)
os.makedirs(nb_target_dir, exist_ok=True)
copyfile(nb_source, nb_target)
def get_nb_toc(fpath):
"""Returns a TOC for the Notebook
It does that by converting first to MD
"""
body = convert.nb2md(fpath)
md_toc_tokens = get_markdown_toc(body)
toc = get_toc(md_toc_tokens)
title = None
for token in md_toc_tokens:
if token["level"] == 1 and title is None:
title = token["name"]
return toc, title |
Beta Was this translation helpful? Give feedback.
2 replies
-
This looks suspicious. Could you please create a minimal reproducible example that showcases the error and attach it here as a zip? |
Beta Was this translation helpful? Give feedback.
-
|
I removed the |
Beta Was this translation helpful? Give feedback.
Answer selected by
squidfunk
-
|
That seems to have fixed it. Thanks, @squidfunk! Much appreciated. |
Beta Was this translation helpful? Give feedback.
0 replies
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
And in case it helps, this is
plugin.pyfile that includes the line that repeats "931 more times":