PackageRenderer

ClassAbstractSource

PackageRenderer(out_dir: str | PathLike[str], saver: SaverAbstract)

This is an abstract class requiring further implementation.

The module parser implemented for rendering documentation pages.

This renderer will be called on each package member and save the parsed information as a documentation page file.

Arguments

Requires

Name	Type	Required	Description
out_dir	str | PathLike[str]		The output directory where the documentation is saved.
saver	SaverAbstract		The saver used for dumping the files.

Methods

parse_class

self.parse_class(obj: DocClass)

Render a member object when it is a class.

Requires

Name	Type	Required	Description
obj	DocClass		The class information to be rendered and saved.

---

parse_dataclass

self.parse_dataclass(obj: DocDataClass)

Render a member object when it is a data class.

Requires

Name	Type	Required	Description
obj	DocDataClass		The data class information to be rendered and saved.

---

parse_enum

self.parse_enum(obj: DocEnum)

Render a member object when it is an enum class.

Requires

Name	Type	Required	Description
obj	DocEnum		The enum information to be rendered and saved.

---

parse_function

self.parse_function(obj: DocFunction)

Render a member object when it is a function.

Requires

Name	Type	Required	Description
obj	DocFunction		The function information to be rendered and saved.

---

parse_module

self.parse_module(obj: DocModule)

Render a member object when it is a module.

Requires

Name	Type	Required	Description
obj	DocModule		The module information to be rendered and saved.

---

parse_protocol

self.parse_protocol(obj: DocProtocol)

Render a member object when it is a protocol class.

Requires

Name	Type	Required	Description
obj	DocProtocol		The protocol class information to be rendered and saved.

---

parse_typealias

self.parse_typealias(obj: DocTypeAlias)

Render a member object when it is a type alias.

Requires

Name	Type	Required	Description
obj	DocTypeAlias		The alias information to be rendered and saved.

---

parse_typeddict

self.parse_typeddict(obj: DocTypedDict)

Render a member object when it is a typed dictionary.

Requires

Name	Type	Required	Description
obj	DocTypedDict		The typed dictionary information to be rendered and saved.

---

save_page

self.save_page(page: RendererPage)

Save the documentation page.

Requires

Name	Type	Required	Description
page	RendererPage		The page to be rendered and saved.