pydoc_fork.reporter.formatter_html
index
../../pydoc_fork/reporter/formatter_html.py

Roughly components

 
Modules
 
pydoc_fork.reporter.inline_styles
logging
markdown
re
pydoc_fork.settings
sysconfig

 
`from` Modules
 
pydoc_fork.reporter.html_repr_class
enum
pydoc_fork.inspector.utils
pydoc_fork.reporter.string_utils
pydoc_fork.inspector.module_utils
pydoc_fork.reporter.rst_support

 
Classes
 
enum.Enum(builtins.object)
MarkupSyntax(enum.Enum)

 
class MarkupSyntax(enum.Enum)
MarkupSyntax(value, names=None, *, module=None, qualname=None, type=None, start=1)
 
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.

Readonly properties inherited from enum.EnumMeta:
__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.

 
Functions
 
bigsection(title: str, fgcol: str, bgcol: 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 grey
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, fgcol: str, bgcol: str, extras: str = '') -> str
Format a page heading.
html_repr(value: Any) -> str
Turn method into function
markup(text: str, funcs: Optional[Dict[str, str]] = None, classes: Optional[Dict[str, str]] = None, methods: Optional[Dict[str, str]] = None) -> str
Replace all linkable things with links of appropriate syntax.
 
Handle either an adhoc 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: Union[Sequence[Tuple[Any, str, Any, int]], Sequence[Tuple[str, Any]]], the_format: Callable[[Any], str], cols: int = 4) -> str
Format a list of items into a multi-column list.
namelink(name: str, *dicts: Dict[str, 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: Union[str, Any], force_load: bool = False) -> Tuple[Any, 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, fgcol: str, bgcol: str, contents: str, width: int = 6, prelude: str = '', marginalia: str = '', gap: str = '&nbsp;') -> str
Format a section with a heading.

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