Classes

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

Entity Name	Description
CppHtmlODARenderer	HTML Renderer for C++.
CppHugoODARenderer	Hugo Renderer for C++.
CsHtmlODARenderer	HTML Renderer for C#.
CsHugoODARenderer	Hugo Renderer for C#.
JavaHtmlODARenderer	HTML Renderer for Java.
JavaHugoODARenderer	Hugo Renderer for Java.
ODAHtmlRenderer	Renderer to convert ProjectCatalog IR into offline-friendly standalone HTML.
ODAHugoMarkdownRenderer	Renderer to convert ProjectCatalog IR into Markdown documentation with YAML front-matter.
PyHtmlODARenderer	HTML Renderer for Python.
PyHugoODARenderer	Hugo Renderer for Python.

Directory & Entity Index

Entity Name Summary / Description

CppHtmlODARenderer class

Extends: ude.renderers.oda.ODAHtmlRenderer

HTML Renderer for C++.

Methods

_classify_entity

_classify_entity(self, entity_type: str) -> str

Groups structs/enums/variables together; classes, functions, and typedefs get their own folders.

Parameter	Type	Description
entity_type	`str`

_resolve_base_filename

_resolve_base_filename(self, base_path: str, overload: str) -> str

Escapes C++ pointer/reference/template symbols and “::” scoping into a flat filename.

Parameter	Type	Description
base_path	`str`
overload	`str`

_get_class_path

_get_class_path(self, namespace_name: str, class_name: str, fully_qualified_name: str) -> str

Builds the “::"-qualified C++ class path from its namespace and name.

CppHugoODARenderer class

Extends: ude.renderers.oda.ODAHugoMarkdownRenderer

Hugo Renderer for C++.

Methods

_classify_entity

_classify_entity(self, entity_type: str) -> str

Groups structs/enums/variables together; classes, functions, and typedefs get their own folders.

Parameter	Type	Description
entity_type	`str`

_resolve_base_filename

_resolve_base_filename(self, base_path: str, overload: str) -> str

Escapes C++ pointer/reference/template symbols and “::” scoping into a flat filename.

Parameter	Type	Description
base_path	`str`
overload	`str`

_get_class_path

_get_class_path(self, namespace_name: str, class_name: str, fully_qualified_name: str) -> str

Builds the “::"-qualified C++ class path from its namespace and name.

CsHtmlODARenderer class

Extends: ude.renderers.oda.ODAHtmlRenderer

HTML Renderer for C#.

Methods

_classify_entity

_classify_entity(self, entity_type: str) -> str

Splits C# entities into Classes/Interfaces/Structures/Enumerations/Delegates folders.

Parameter	Type	Description
entity_type	`str`

_resolve_base_filename

_resolve_base_filename(self, base_path: str, overload: str) -> str

Flattens C#’s dotted namespace path into a “_"-joined filename.

ODA variant: joins with a single “_” (the current renderer, in ude.renderers.static_html.CsHtmlDefaultRenderer, uses “__”).

Parameter	Type	Description
base_path	`str`
overload	`str`

_get_class_path

_get_class_path(self, namespace_name: str, class_name: str, fully_qualified_name: str) -> str

CsHugoODARenderer class

Extends: ude.renderers.oda.ODAHugoMarkdownRenderer

Hugo Renderer for C#.

Methods

_classify_entity

_classify_entity(self, entity_type: str) -> str

Splits C# entities into Classes/Interfaces/Structures/Enumerations/Delegates folders.

Parameter	Type	Description
entity_type	`str`

_resolve_base_filename

_resolve_base_filename(self, base_path: str, overload: str) -> str

Flattens C#’s dotted namespace path into a “_"-joined filename.

ODA variant: joins with a single “_” (the current renderer, in ude.renderers.hugo_markdown.CsHugoDefaultRenderer, uses “__”).

Parameter	Type	Description
base_path	`str`
overload	`str`

_get_class_path

_get_class_path(self, namespace_name: str, class_name: str, fully_qualified_name: str) -> str

JavaHtmlODARenderer class

Extends: ude.renderers.oda.ODAHtmlRenderer

HTML Renderer for Java.

Methods

_classify_entity

_classify_entity(self, entity_type: str) -> str

Splits Java entities into Classes/Interfaces/Enumerations/Exceptions/Errors/Annotations folders.

Parameter	Type	Description
entity_type	`str`

_resolve_base_filename

_resolve_base_filename(self, base_path: str, overload: str) -> str

Splits the Java package/class path at the first capitalized (class-name) segment, joining both the package and class parts with “_”.

ODA variant: the class part uses “_” (the current renderer, in ude.renderers.static_html.JavaHtmlDefaultRenderer, uses “__”).

Parameter	Type	Description
base_path	`str`
overload	`str`

_get_class_path

_get_class_path(self, namespace_name: str, class_name: str, fully_qualified_name: str) -> str

JavaHugoODARenderer class

Extends: ude.renderers.oda.ODAHugoMarkdownRenderer

Hugo Renderer for Java.

Methods

_classify_entity

_classify_entity(self, entity_type: str) -> str

Splits Java entities into Classes/Interfaces/Enumerations/Exceptions/Errors/Annotations folders.

Parameter	Type	Description
entity_type	`str`

_resolve_base_filename

_resolve_base_filename(self, base_path: str, overload: str) -> str

Splits the Java package/class path at the first capitalized (class-name) segment, joining both the package and class parts with “_”.

ODA variant: the class part uses “_” (the current renderer, in ude.renderers.hugo_markdown.JavaHugoDefaultRenderer, uses “__”).

Parameter	Type	Description
base_path	`str`
overload	`str`

_get_class_path

_get_class_path(self, namespace_name: str, class_name: str, fully_qualified_name: str) -> str

ODAHtmlRenderer class

Extends: ude.interfaces.BaseRenderer

Renderer to convert ProjectCatalog IR into offline-friendly standalone HTML.

Satisfies REQ-FUN-03, REQ-FUN-30, REQ-FUN-31, REQ-FUN-32

Class Variables

ude.renderers.oda.ODAHtmlRenderer.curr
str ude.renderers.oda.ODAHtmlRenderer.candidate

Instance Variables

ude.renderers.oda.ODAHtmlRenderer.__class__
ude.renderers.oda.ODAHtmlRenderer.language
ude.renderers.oda.ODAHtmlRenderer.assets_src_dir
ude.renderers.oda.ODAHtmlRenderer.catalog_links
ude.renderers.oda.ODAHtmlRenderer.config
ude.renderers.oda.ODAHtmlRenderer.toc_config
ude.renderers.oda.ODAHtmlRenderer.entity_type
ude.renderers.oda.ODAHtmlRenderer._groups_signature_salt
ude.renderers.oda.ODAHtmlRenderer._template_hash
ude.renderers.oda.ODAHtmlRenderer._rendered_targets

Methods

init

__init__(self, language: str, assets_src_dir: str, catalog_links: list, config: dict, cache_dir: Optional, cache_manager: Optional)

Initializes the ODAHtmlRenderer with a specific target language mapping.

Parameter	Type	Description
language	`str`	The target language token (e.g. “cpp”, “python”).
assets_src_dir	`str`	Filesystem source directory for static assets
catalog_links	`list`	Extra cross-reference links injected into every
config	`dict`	The merged doc-config dict for the current render target.
cache_dir	`Optional`	Optional on-disk cache directory, forwarded to `BaseRenderer`.
cache_manager	`Optional`	Optional build cache manager, forwarded to `BaseRenderer`.

new

__new__(cls, language: str, cache_manager: Optional) -> ODAHtmlRenderer

ODAHugoMarkdownRenderer class

Extends: ude.interfaces.BaseRenderer

Renderer to convert ProjectCatalog IR into Markdown documentation with YAML front-matter.

Satisfies REQ-FUN-03

Instance Variables

ude.renderers.oda.ODAHugoMarkdownRenderer.__class__
ude.renderers.oda.ODAHugoMarkdownRenderer.language
ude.renderers.oda.ODAHugoMarkdownRenderer.catalog_links
ude.renderers.oda.ODAHugoMarkdownRenderer.config
ude.renderers.oda.ODAHugoMarkdownRenderer.toc_config
ude.renderers.oda.ODAHugoMarkdownRenderer.name
ude.renderers.oda.ODAHugoMarkdownRenderer.docstring
ude.renderers.oda.ODAHugoMarkdownRenderer._groups_signature_salt
ude.renderers.oda.ODAHugoMarkdownRenderer._template_hash
ude.renderers.oda.ODAHugoMarkdownRenderer._rendered_targets

Methods

init

__init__(self, language: str, catalog_links: list, config: dict, cache_dir: Optional, cache_manager: Optional)

Initializes the ODAHugoMarkdownRenderer with a specific target language.

Parameter	Type	Description
language	`str`	The target language token (e.g. “cpp”, “python”).
catalog_links	`list`	Extra cross-reference links injected into every
config	`dict`	The merged doc-config dict for the current render target.
cache_dir	`Optional`	Optional on-disk cache directory, forwarded to `BaseRenderer`.
cache_manager	`Optional`	Optional build cache manager, forwarded to `BaseRenderer`.

new

__new__(cls, language: str, cache_manager: Optional) -> ODAHugoMarkdownRenderer

PyHtmlODARenderer class

Extends: ude.renderers.oda.ODAHtmlRenderer

HTML Renderer for Python.

Instance Variables

ude.renderers.oda.PyHtmlODARenderer.name
ude.renderers.oda.PyHtmlODARenderer.docstring
ude.renderers.oda.PyHtmlODARenderer.classes
ude.renderers.oda.PyHtmlODARenderer.methods
ude.renderers.oda.PyHtmlODARenderer.fully_qualified_name

Methods

_classify_entity

_classify_entity(self, entity_type: str) -> str

Splits Python entities into Exceptions/Functions/Classes folders (no Variables/Typedefs/Structs split).

Parameter	Type	Description
entity_type	`str`

_resolve_base_filename

_resolve_base_filename(self, base_path: str, overload: str) -> str

Splits the Python module/class path at the first capitalized (class-name) segment, joining the module part with “_” and any nested-class suffix with “__”.

Parameter	Type	Description
base_path	`str`
overload	`str`

_get_class_path

_get_class_path(self, namespace_name: str, class_name: str, fully_qualified_name: str) -> str

PyHugoODARenderer class

Extends: ude.renderers.oda.ODAHugoMarkdownRenderer

Hugo Renderer for Python.

Methods

_classify_entity

_classify_entity(self, entity_type: str) -> str

Splits Python entities into Exceptions/Functions/Variables/Typedefs/Structs_and_Enums/Classes folders.

Parameter	Type	Description
entity_type	`str`

_resolve_base_filename

_resolve_base_filename(self, base_path: str, overload: str) -> str

Splits the Python module/class path at the first capitalized (class-name) segment, joining the module part with “_” and any nested-class suffix with “__”.

Parameter	Type	Description
base_path	`str`
overload	`str`

_get_class_path

_get_class_path(self, namespace_name: str, class_name: str, fully_qualified_name: str) -> str