Participer au site avec un Tip
Rechercher
 

Améliorations / Corrections

Vous avez des améliorations (ou des corrections) à proposer pour ce document : je vous remerçie par avance de m'en faire part, cela m'aide à améliorer le site.

Emplacement :

Description des améliorations :

Module « pydoc » Python 3.11.3

Classe « HTMLDoc »

Informations générales

Héritage

builtins.object
    Doc
        HTMLDoc

Définition

class HTMLDoc(Doc):

help(HTMLDoc)

Formatter class for HTML documentation.

Constructeur(s)

Signature du constructeur Description
__init__(self, /, *args, **kwargs) Initialize self. See help(type(self)) for accurate signature. [extrait de __init__.__doc__]

Liste des attributs statiques

Nom de l'attribut Valeur
PYTHONDOCShttps://docs.python.org/3.11/library

Liste des opérateurs

Opérateurs hérités de la classe object

__eq__, __ge__, __gt__, __le__, __lt__, __ne__

Liste des méthodes

Toutes les méthodes Méthodes d'instance Méthodes statiques Méthodes dépréciées
Signature de la méthodeDescription
bigsection(self, title, *args) Format a section with a big heading. [extrait de bigsection.__doc__]
classlink(self, object, modname) Make a link for a class. [extrait de classlink.__doc__]
docclass(self, object, name=None, mod=None, funcs={}, classes={}, *ignored) Produce HTML documentation for a class object. [extrait de docclass.__doc__]
docdata(self, object, name=None, mod=None, cl=None) Produce html documentation for a data descriptor. [extrait de docdata.__doc__]
docmodule(self, object, name=None, mod=None, *ignored) Produce HTML documentation for a module object. [extrait de docmodule.__doc__]
docother(self, object, name=None, mod=None, *ignored) Produce HTML documentation for a data object. [extrait de docother.__doc__]
docproperty(self, object, name=None, mod=None, cl=None) Produce html documentation for a data descriptor. [extrait de docdata.__doc__]
docroutine(self, object, name=None, mod=None, funcs={}, classes={}, methods={}, cl=None) Produce HTML documentation for a function or method object. [extrait de docroutine.__doc__]
filelink(self, url, path) Make a link to source file. [extrait de filelink.__doc__]
formattree(self, tree, modname, parent=None) Produce HTML for a class tree as given by inspect.getclasstree(). [extrait de formattree.__doc__]
formatvalue(self, object) Format an argument default value as text. [extrait de formatvalue.__doc__]
grey(self, text)
heading(self, title, extras='') Format a page heading. [extrait de heading.__doc__]
index(self, dir, shadowed=None) Generate an HTML index for a directory of modules. [extrait de index.__doc__]
markup(self, text, escape=None, funcs={}, classes={}, methods={}) Mark up some plain text, given a context of symbols to look for. [extrait de markup.__doc__]
modpkglink(self, modpkginfo) Make a link for a module or package to display in an index. [extrait de modpkglink.__doc__]
modulelink(self, object) Make a link for a module. [extrait de modulelink.__doc__]
multicolumn(self, list, format) Format a list of items into a multi-column list. [extrait de multicolumn.__doc__]
namelink(self, name, *dicts) Make a link for an identifier, given name-to-URL mappings. [extrait de namelink.__doc__]
page(self, title, contents) Format an HTML page. [extrait de page.__doc__]
preformat(self, text) Format literal preformatted text. [extrait de preformat.__doc__]
section(self, title, cls, contents, width=6, prelude='', marginalia=None, gap=' ') Format a section with a heading. [extrait de section.__doc__]

Méthodes héritées de la classe Doc

__init_subclass__, __subclasshook__, document, fail, getdocloc

Méthodes héritées de la classe object

__delattr__, __dir__, __format__, __getattribute__, __getstate__, __hash__, __init_subclass__, __reduce__, __reduce_ex__, __repr__, __setattr__, __sizeof__, __str__, __subclasshook__