import logging import os import posixpath import re import traceback from typing import Any, Callable, Dict from markdown import Markdown from mkdocs.structure.files import Files, File from mkdocs.structure.pages import Page from pymdownx.superfences import SuperFencesException from _scripts.hook_state import hook_state from markdown_exec.hooks import SessionHistoryEntry from _scripts.generate_api_reference_links import update_markdown_with_imports from _scripts.notebook_convert import convert_notebook from _scripts.setup_vcr import get_hash_for_session, load_postamble, load_preamble, _hash_string logger = logging.getLogger(__name__) logging.basicConfig() logger.setLevel(logging.INFO) DISABLED = os.getenv("DISABLE_NOTEBOOK_CONVERT") in ("1", "true", "True") REDIRECT_MAP = { # lib redirects "how-tos/stream-values.ipynb": "how-tos/streaming.ipynb#values", "how-tos/stream-updates.ipynb": "how-tos/streaming.ipynb#updates", "how-tos/streaming-content.ipynb": "how-tos/streaming.ipynb#custom", "how-tos/stream-multiple.ipynb": "how-tos/streaming.ipynb#multiple", "how-tos/streaming-tokens-without-langchain.ipynb": "how-tos/streaming-tokens.ipynb#example-without-langchain", "how-tos/streaming-from-final-node.ipynb": "how-tos/streaming-specific-nodes.ipynb", "how-tos/streaming-events-from-within-tools-without-langchain.ipynb": "how-tos/streaming-events-from-within-tools.ipynb#example-without-langchain", # cloud redirects "cloud/index.md": "concepts/index.md#langgraph-platform", "cloud/how-tos/index.md": "how-tos/index.md#langgraph-platform", "cloud/concepts/api.md": "concepts/langgraph_server.md", "cloud/concepts/cloud.md": "concepts/langgraph_cloud.md", "cloud/faq/studio.md": "concepts/langgraph_studio.md#studio-faqs", } class NotebookFile(File): def is_documentation_page(self): return True def on_files(files: Files, **kwargs: Dict[str, Any]): if DISABLED: return files new_files = Files([]) for file in files: if file.src_path.endswith(".ipynb"): new_file = NotebookFile( path=file.src_path, src_dir=file.src_dir, dest_dir=file.dest_dir, use_directory_urls=file.use_directory_urls, ) new_files.append(new_file) else: new_files.append(file) return new_files def _highlight_code_blocks(markdown: str) -> str: """Find code blocks with highlight comments and add hl_lines attribute. Args: markdown: The markdown content to process. Returns: updated Markdown code with code blocks containing highlight comments updated to use the hl_lines attribute. """ # Pattern to find code blocks with highlight comments and without # existing hl_lines for Python and JavaScript # Pattern to find code blocks with highlight comments, handling optional indentation code_block_pattern = re.compile( r"(?P[ \t]*)```(?P\w+)[ ]*(?P[^\n]*)\n" r"(?P((?:.*\n)*?))" # Capture the code inside the block using named group r"(?P=indent)```" # Match closing backticks with the same indentation ) def replace_highlight_comments(match: re.Match) -> str: indent = match.group("indent") language = match.group("language") code_block = match.group("code") attributes = match.group("attributes").rstrip() # Account for a case where hl_lines is manually specified if "hl_lines" in attributes: # Return original code block return match.group(0) lines = code_block.split("\n") highlighted_lines = [] # Skip initial empty lines while lines and not lines[0].strip(): lines.pop(0) lines_to_keep = [] comment_syntax = ( "# highlight-next-line" if language in ["py", "python"] else "// highlight-next-line" ) for line in lines: if comment_syntax in line: count = len(lines_to_keep) + 1 highlighted_lines.append(str(count)) else: lines_to_keep.append(line) # Reconstruct the new code block new_code_block = "\n".join(lines_to_keep) # Construct the full code block that also includes # the fenced code block syntax. opening_fence = f"```{language}" if attributes: opening_fence += f" {attributes}" if highlighted_lines: opening_fence += f" hl_lines=\"{' '.join(highlighted_lines)}\"" return ( # The indent and opening fence f"{indent}{opening_fence}\n" # The indent and terminating \n is already included in the code block f"{new_code_block}" f"{indent}```" ) # Replace all code blocks in the markdown markdown = code_block_pattern.sub(replace_highlight_comments, markdown) return markdown def handle_vcr_setup( *, formatter: Callable, language: str, code: str, session: str, id: str, md: Markdown, **kwargs: Dict[str, Any], ) -> Dict[str, Any]: """Handle VCR setup in markdown content if necessary.""" logger.info(f"handle_vcr_setup: {hook_state['document_filename']}") try: if hook_state['document_filename'] == '__UNKNOWN__': raise SuperFencesException( f"error while processing {language} block: document filename hasn't been set yet" ) if hook_state['document_content'] == '__UNKNOWN__': raise SuperFencesException( f"error while processing {language} block: document content hasn't been set yet" ) if session is None or session == "" and id is None or id == "": id = _hash_string(code) if session is not None and session != "": logger.info(f"new {language} session {session} on page {hook_state['document_filename']}") cassette_prefix = hook_state['document_filename'].replace(".md", "").replace(os.path.sep, "_") cassette_dir = os.path.abspath( os.path.join(os.path.dirname(os.path.dirname(__file__)), "cassettes") ) os.makedirs(cassette_dir, exist_ok=True) # Build a unique cassette name. cassette_name = os.path.join( cassette_dir, f"{cassette_prefix}_{session if session else id}_{language}.msgpack.zlib", ) # Add context manager at start with explicit __enter__ and __exit__ calls hash_ = get_hash_for_session(language, session, hook_state['document_content']) wrapped_lines = [ load_preamble(language, hash_, cassette_name), code, ] if session is None or session == "": logger.info( f"no session, adding postamble for {language} in {hook_state['document_filename']}" ) wrapped_lines.append(load_postamble(language)) transformed_source = "\n".join(wrapped_lines) # Propagate extras keep_extras = { key: value for key, value in kwargs["extra"].items() if key in { "hl_lines", } } return dict( transform_source=lambda code: (transformed_source, code), id=id, extra={ **keep_extras, "path": hook_state['document_filename'] }, ) except Exception as e: raise SuperFencesException(traceback.format_exc()) from e def handle_vcr_teardown( *, formatter: Callable, language: str, session: str, history: list[SessionHistoryEntry], ): code = load_postamble(language) html = False update_toc = False logger.info(f"tearing down {language} {session} on {hook_state['document_filename']}") kwargs = dict( code=code, session=session, id=f"{id}_vcr_end", md=None, # md is unused by the formatter, but it's a required argument html=html, update_toc=update_toc, extra={}, ) # This doesn't actually render anything, we just call the formatter so it # executes in the same context as the session of which we're disposing. formatter(**kwargs) def _on_page_markdown_with_config( markdown: str, page: Page, *, add_api_references: bool = True, remove_base64_images: bool = False, **kwargs: Any, ) -> str: if DISABLED: return markdown if page.file.src_path.endswith(".ipynb"): # logger.info("Processing Jupyter notebook: %s", page.file.src_path) markdown = convert_notebook(page.file.abs_src_path) # Append API reference links to code blocks if add_api_references: markdown = update_markdown_with_imports(markdown, page.file.src_path) # Apply highlight comments to code blocks markdown = _highlight_code_blocks(markdown) if remove_base64_images: # Remove base64 encoded images from markdown markdown = re.sub(r"!\[.*?\]\(data:image/+;base64,[^\)]+\)", "", markdown) return markdown def on_page_markdown(markdown: str, page: Page, **kwargs: Dict[str, Any]): logger.info(f"on_page_markdown: {page.file.src_path}") hook_state['document_filename'] = page.file.src_path return _on_page_markdown_with_config( markdown, page, add_api_references=True, **kwargs, ) # redirects HTML_TEMPLATE = """ Redirecting... Redirecting... """ def write_html(site_dir, old_path, new_path): """Write an HTML file in the site_dir with a meta redirect to the new page""" # Determine all relevant paths old_path_abs = os.path.join(site_dir, old_path) old_dir_abs = os.path.dirname(old_path_abs) # Create parent directories if they don't exist if not os.path.exists(old_dir_abs): os.makedirs(old_dir_abs) # Write the HTML redirect file in place of the old file content = HTML_TEMPLATE.format(url=new_path) with open(old_path_abs, "w", encoding="utf-8") as f: f.write(content) # Create HTML files for redirects after site dir has been built def on_post_build(config): use_directory_urls = config.get("use_directory_urls") for page_old, page_new in REDIRECT_MAP.items(): page_old = page_old.replace(".ipynb", ".md") page_new = page_new.replace(".ipynb", ".md") page_new_before_hash, hash, suffix = page_new.partition("#") old_html_path = File(page_old, "", "", use_directory_urls).dest_path.replace( os.sep, "/" ) new_html_path = File(page_new_before_hash, "", "", True).url new_html_path = ( posixpath.relpath(new_html_path, start=posixpath.dirname(old_html_path)) + hash + suffix ) write_html(config["site_dir"], old_html_path, new_html_path) def on_pre_page(page: Page, **kwargs: Dict[str, Any]): logger.info(f"on_pre_page: {page.file.src_path}") hook_state['document_filename'] = page.file.src_path hook_state['document_content'] = page.file.content_string return page