Special types and examples of extracted pages

This is a summary of the currently supported types that will be rendered as documentation pages with corresponding styles. Take a quick look at the examples of each rendered page to learn how pyDocusaurus performs.

tip

The API documents of this site is generated by pyDocusaurus. The following tables list the representative pages rendered from different Python data types. Check them to view the performance of the currently viewed version.

1. Modules

Type	pyDocusaurus Data	Example Page
package	DocModule	core
module	DocModule	core.modules

2. Functions and properties

Type	pyDocusaurus Data	Example Page
function	DocFunction	parse_argument_docs
function (iterator)	DocFunction	get_members_defined_in_class
method	DocFunction	Components.get_headers
classmethod	DocFunction	ClassProfile.from_class
staticmethod	DocFunction	PackageWalker.get_member_type
property	DocProp	Components.apibar
operator	DocOpTemplate	dfc.caches.lrudict.LRUDict.__getitem__

3. Classes

Type	pyDocusaurus Data	Example Page
class	DocClass	Components dfc.caches.lrudict.LRUDict
abc.ABC	DocClass	SaverAbstract
dataclass or pydantic.BaseModel	DocDataClass	ClassProfile RendererPage
enum	DocEnum	FunctionType

4. Types

Type	pyDocusaurus Data	Example Page
typealias	DocTypeAlias	dfc.caches.typehints.Deferred
typedict	DocTypedDict	dfc.caches.typehints.CachedFileInfo
protocol	DocProtocol	ProtocolComponent