Skip to main content

​
mdxify.generator

MDX documentation generation.

​
Functions

​
is_module_empty 

is_module_empty(module_path: Path) -> bool
Check if a module documentation file indicates it’s empty.

​
generate_mdx 

generate_mdx(module_info: dict[str, Any], output_file: Path, repo_url: Optional[str] = None, branch: str = 'main', root_module: Optional[str] = None, renderer: Optional[Renderer] = None) -> None
Generate MDX documentation from module info. Args:
  • module_info: Parsed module information
  • output_file: Path to write the MDX file
  • repo_url: GitHub repository URL for source links
  • branch: Git branch name for source links
  • root_module: Root module name for finding relative paths