List of classes in the ude.renderers.oda namespace.

ODA HTML and Hugo Markdown renderers.

Target-format variant of ude.renderers.static_html and ude.renderers.hugo_markdown, producing output aligned with Open Design Alliance (ODA) / Doc-O-Matic documentation conventions rather than UDE’s own default conventions. Structurally mirrors the Default renderers (factory __new__/__setattr__ dynamic subclassing, per-language hook methods), but the per-language hooks here are abstract (NotImplementedError) rather than defaulted, and several filename-sanitization rules differ subtly from the Default renderers (see _sanitize_relative_filename and the C#/Java hook overrides below) to match ODA’s conventions.

Entity NameDescription
CppHtmlODARendererHTML Renderer for C++.
CppHugoODARendererHugo Renderer for C++.
CsHtmlODARendererHTML Renderer for C#.
CsHugoODARendererHugo Renderer for C#.
JavaHtmlODARendererHTML Renderer for Java.
JavaHugoODARendererHugo Renderer for Java.
ODAHtmlRendererRenderer to convert ProjectCatalog IR into offline-friendly standalone HTML.
ODAHugoMarkdownRendererRenderer to convert ProjectCatalog IR into Markdown documentation with YAML front-matter.
PyHtmlODARendererHTML Renderer for Python.
PyHugoODARendererHugo Renderer for Python.
markdown_to_htmlSimple, offline-safe markdown parser converting docstrings to basic HTML tags.
_sanitize_relative_filenameNeutralizes path separators, drive-absolute markers, and traversal segments so a resolved filename can never escape the renderer’s output directory, no matter how a malformed entity/namespace name (bad Doxygen XML, corrupted IR) reaches this point.
make_resolve_filename_wrapperCreates a wrapper for resolve_filename to strip the virtual group prefix from absolute class paths when generating links inside category landing pages.
logger
DEFAULT_FALLBACK_TEMPLATESelf-contained HTML template used when no physical template file is found on disk, so rendering never hard-fails on a missing template asset.

Directory & Entity Index

Entity NameSummary / Description
ClassesList of classes in ude.renderers.oda
FunctionsList of functions in ude.renderers.oda
VariablesList of variables in ude.renderers.oda