pydoc_fork.reporter.formatter_html

enum.Enum(builtins.object)

MarkupSyntax(enum.Enum)

class MarkupSyntax(enum.Enum)

MarkupSyntax(*values)
 
Syntax type we assume comments are using
 

Method resolution order:

MarkupSyntax

enum.Enum

builtins.object

---

Data and other attributes defined here:

MARKDOWN = <MarkupSyntax.MARKDOWN: 2>

NOTHING = <MarkupSyntax.NOTHING: 0>

RST = <MarkupSyntax.RST: 1>

---

Data descriptors inherited from enum.Enum:

name

The name of the Enum member.

value

The value of the Enum member.

---

Methods inherited from enum.EnumType:

__contains__(value) from enum.EnumType

Return True if `value` is in `cls`.
 
`value` is in `cls` if:
1) `value` is a member of `cls`, or
2) `value` is the value of one of the `cls`'s members.
3) `value` is a pseudo-member (flags)

__getitem__(name) from enum.EnumType

Return the member matching `name`.

__iter__() from enum.EnumType

Return members in definition order.

__len__() from enum.EnumType

Return the number of members (no aliases)

---

Readonly properties inherited from enum.EnumType:

__members__

Returns a mapping of member name->value.
 
This mapping lists all enum members, including aliases. Note that this
is a read-only view of the internal mapping.

bigsection(title: str, contents: str = '', width: int = 6, prelude: str = '', marginalia: str = '', gap: str = '&nbsp;') -> str

Format a section with a big heading.

cast(typ, val)

Cast a value to a type.
 
This returns the value unchanged.  To the type checker this
signals that the return value has the designated type, but at
runtime we intentionally don't check anything (we want this
to be as fast as possible).

disabled_text(text: str) -> str

Wrap in gray

escape(value: Any) -> str

HTML safe repr and escape

file_link(url: str, path: str) -> str

Make a link to source file.

heading(title: str, extras: str = '', nav_links: collections.abc.Sequence[str] | None = None) -> str

Format a page heading.

html_repr(value: Any) -> str

Turn method into function

markup(text: str, funcs: dict[Any, str] | None = None, classes: dict[Any, str] | None = None, methods: dict[Any, str] | None = None) -> str

Replace all linkable things with links of appropriate syntax.
 
Handle either an ad hoc markup language, or RST or Markdown.
funcs, classes, methods are name/symbol to URL maps.

module_package_link(module_package_info: tuple[str, str, str, str]) -> str

Make a link for a module or package to display in an index.

multicolumn(the_list: collections.abc.Sequence[typing.Any], the_format: collections.abc.Callable[[typing.Any], str], cols: int = 4) -> str

Format a list of items into a multi-column list.

namelink(name: str, *dicts: dict[typing.Any, str]) -> str

Make a link for an identifier, given name-to-URL mappings.

preformat(text: str) -> str

Format literal preformatted text.

replace(text: str, *pairs: str) -> str

Do a series of global replacements on a string.
>>> replace("abc xyz", "xyz", "abc")
'abc abc'

resolve(thing: str | Any, force_load: bool = False) -> tuple[typing.Any, typing.Any]

Given an object or a path to an object, get the object and its name.

rst_to_html(text: str) -> str

Convert rst string to html string

section(title: str, contents: str = '', width: int = 6, prelude: str = '', marginalia: str = '', gap: str = '&nbsp;', section_class: str = 'theme-sub-section') -> str

Format a section with a heading.

JINJA_ENV = <jinja2.environment.Environment object>
LOGGER = <Logger pydoc_fork.reporter.formatter_html (WARNING)>
STDLIB_BASEDIR = r'C:\Users\matth\AppData\Local\Programs\Python\Python314\Lib'