Documenter

Documenter(self, tree)

A class to document a Blender NodeTree.

Parameters

Name	Type	Description	Default
tree	bpy.types.NodeTree	The Blender NodeTree to document.	required

Attributes

Name	Type	Description
tree	bpy.types.NodeTree	The Blender NodeTree being documented.
level	int	The markdown heading level for the title.
title	Title	The title of the NodeTree.
items	list of InterfaceItem	The items in the NodeTree’s interface.
inputs	InterfaceGroup	The input items in the NodeTree’s interface.
outputs	InterfaceGroup	The output items in the NodeTree’s interface.

Properties

name : str The name of the NodeTree. description : Description The description of the NodeTree. videos : Videos The videos related to the NodeTree.

Methods

Name	Description
as_markdown	Convert collected items to a markdown formatted string.
collect_items	Collects and returns a list of markdown-formatted items.
lookup_info	Populate the video and other additional data from the extra_json dictionary.

as_markdown

Documenter.as_markdown()

Convert collected items to a markdown formatted string.

Returns

Name	Type	Description
	str	A string containing the collected items formatted as markdown.

collect_items

Documenter.collect_items()

Collects and returns a list of markdown-formatted items.

This method gathers various attributes of the object, converts them to markdown format, and returns a list of these items. Only non-None items are included in the returned list.

Returns

Name	Type	Description
	list of str	A list of markdown-formatted strings representing the title, description, videos, outputs, and inputs of the object.

lookup_info

Documenter.lookup_info(extra_json)

Populate the video and other additional data from the extra_json dictionary.

Matches up additional information that isn’t currently stored on the nodes themselves

Parameters

Name	Type	Description	Default
extra_json	dict	A dictionary containing additional JSON data. It is expected to have a structure where extra_json[self.name]["videos"] is a list of video links.	required

Returns

Name	Type	Description
	None	This method does not return any value.

Raises

Name	Type	Description
	KeyError	If self.name or "videos" key is not found in extra_json, the exception is caught and ignored.