| | |
- pydoc.HTMLDoc(pydoc.Doc)
-
- HTMLDoc
- pydoc.Helper(builtins.object)
-
- Helper
- pydoc.ModuleScanner(builtins.object)
-
- ModuleScanner
- pydoc.TextDoc(pydoc.Doc)
-
- TextDoc
class HTMLDoc(pydoc.HTMLDoc) |
| |
Formatter class for Xplor-NIH HTML documentation.
|
| |
- Method resolution order:
- HTMLDoc
- pydoc.HTMLDoc
- pydoc.Doc
- builtins.object
Methods defined here:
- classlink(self, object, modname)
- Make a link for a class.
- docdata(self, object, name=None, mod=None, cl=None)
- Produce html documentation for a data descriptor.
- docmodule(self, object, name=None, mod=None, *ignored)
- Produce HTML documentation for a module object.
- docproperty = docdata(self, object, name=None, mod=None, cl=None)
- escape(text) from pydoc.HTMLRepr
- filelink(self, url, path)
- file: links don't work on the network, so a different approach
should be taken, where all possible pages are generated, then a proper
https: link made. As it is, this simply doesn't work, and exposes
local path/username info.
- markup(self, text, escape=None, funcs={}, classes={}, methods={})
- Mark up some plain text, given a context of symbols to look for.
some simple tags are defined:
<\m NAME> - creates a link for Xplor-NIH module named NAME
<\s NAME> - creates a link for Python module named NAME
<\l LINK NAME> - creates a link LINK with tag NAME
<string>
- process a block of text as reStructedText.
[In each case, please do not include the backslash character.]
Each context dictionary maps object names to anchor names.
- modulelink(self, object)
- Make a link for a module.
- repr(object) from pydoc.HTMLRepr
Methods inherited from pydoc.HTMLDoc:
- bigsection(self, title, *args)
- Format a section with a big heading.
- docclass(self, object, name=None, mod=None, funcs={}, classes={}, *ignored)
- Produce HTML documentation for a class object.
- docother(self, object, name=None, mod=None, *ignored)
- Produce HTML documentation for a data object.
- docroutine(self, object, name=None, mod=None, funcs={}, classes={}, methods={}, cl=None)
- Produce HTML documentation for a function or method object.
- formattree(self, tree, modname, parent=None)
- Produce HTML for a class tree as given by inspect.getclasstree().
- formatvalue(self, object)
- Format an argument default value as text.
- grey(self, text)
- heading(self, title, extras='')
- Format a page heading.
- index(self, dir, shadowed=None)
- Generate an HTML index for a directory of modules.
- modpkglink(self, modpkginfo)
- Make a link for a module or package to display in an index.
- multicolumn(self, list, format)
- Format a list of items into a multi-column list.
- namelink(self, name, *dicts)
- Make a link for an identifier, given name-to-URL mappings.
- page(self, title, contents)
- Format an HTML page.
- preformat(self, text)
- Format literal preformatted text.
- section(self, title, cls, contents, width=6, prelude='', marginalia=None, gap=' ')
- Format a section with a heading.
Methods inherited from pydoc.Doc:
- document(self, object, name=None, *args)
- Generate documentation for an object.
- fail(self, object, name=None, *args)
- Raise an exception for unimplemented types.
- getdocloc(self, object, basedir='/home/schwitrs/xplor/python/bin.Linux_x86_64/lib/python3.11')
- Return the location of module docs or None
Data descriptors inherited from pydoc.Doc:
- __dict__
dictionary for instance variables (if defined)
- __weakref__
list of weak references to the object (if defined)
Data and other attributes inherited from pydoc.Doc:
- PYTHONDOCS = 'https://docs.python.org/3.11/library'
|
class Helper(pydoc.Helper) |
| |
Helper(input=None, output=None)
|
| |
- Method resolution order:
- Helper
- pydoc.Helper
- builtins.object
Methods defined here:
- __call__(self, request=<object object at 0x7f4949db4700>)
- Call self as a function.
- help(self, request)
Methods inherited from pydoc.Helper:
- __init__(self, input=None, output=None)
- Initialize self. See help(type(self)) for accurate signature.
- __repr__(self)
- Return repr(self).
- getline(self, prompt)
- Read one line, using input() when appropriate.
- interact(self)
- intro(self)
- list(self, items, columns=4, width=80)
- listkeywords(self)
- listmodules(self, key='')
- listsymbols(self)
- listtopics(self)
- showsymbol(self, symbol)
- showtopic(self, topic, more_xrefs='')
Readonly properties inherited from pydoc.Helper:
- input
- output
Data descriptors inherited from pydoc.Helper:
- __dict__
dictionary for instance variables (if defined)
- __weakref__
list of weak references to the object (if defined)
Data and other attributes inherited from pydoc.Helper:
- keywords = {'False': '', 'None': '', 'True': '', 'and': 'BOOLEAN', 'as': 'with', 'assert': ('assert', ''), 'async': ('async', ''), 'await': ('await', ''), 'break': ('break', 'while for'), 'class': ('class', 'CLASSES SPECIALMETHODS'), ...}
- symbols = {'!=': 'OPERATORS COMPARISON', '"': 'STRINGS', '"""': 'STRINGS', '%': 'OPERATORS FORMATTING', '%=': 'AUGMENTEDASSIGNMENT', '&': 'OPERATORS BITWISE', '&=': 'AUGMENTEDASSIGNMENT', "'": 'STRINGS', "'''": 'STRINGS', '(': 'TUPLES FUNCTIONS CALLS', ...}
- topics = {'ASSERTION': 'assert', 'ASSIGNMENT': ('assignment', 'AUGMENTEDASSIGNMENT'), 'ATTRIBUTEMETHODS': ('attribute-access', 'ATTRIBUTES SPECIALMETHODS'), 'ATTRIBUTES': ('attribute-references', 'getattr hasattr setattr ATTRIBUTEMETHODS'), 'AUGMENTEDASSIGNMENT': ('augassign', 'NUMBERMETHODS'), 'BASICMETHODS': ('customization', 'hash repr str SPECIALMETHODS'), 'BINARY': ('binary', 'EXPRESSIONS'), 'BITWISE': ('bitwise', 'EXPRESSIONS'), 'BOOLEAN': ('booleans', 'EXPRESSIONS TRUTHVALUE'), 'CALLABLEMETHODS': ('callable-types', 'CALLS SPECIALMETHODS'), ...}
|
class TextDoc(pydoc.TextDoc) |
| |
Formatter class for text documentation.
|
| |
- Method resolution order:
- TextDoc
- pydoc.TextDoc
- pydoc.Doc
- builtins.object
Methods defined here:
- docclass(self, object, name=None, mod=None, *ignored)
- Produce text documentation for a given class object. This
differs from the version in the base class by the version of getdoc
called.
- docmodule(self, object, name=None, mod=None)
- Produce text documentation for a given module object.
- docroutine(self, object, name=None, mod=None, cl=None)
- Produce text documentation for a function or method object.
- markup(self, text)
- remove markup tags.
- repr(x) from pydoc.TextRepr
- section(self, title, contents)
- Format a section with a given heading.
Methods inherited from pydoc.TextDoc:
- bold(self, text)
- Format a string in bold by overstriking.
- docdata(self, object, name=None, mod=None, cl=None)
- Produce text documentation for a data descriptor.
- docother(self, object, name=None, mod=None, parent=None, maxlen=None, doc=None)
- Produce text documentation for a data object.
- docproperty = docdata(self, object, name=None, mod=None, cl=None)
- formattree(self, tree, modname, parent=None, prefix='')
- Render in text a class tree as returned by inspect.getclasstree().
- formatvalue(self, object)
- Format an argument default value as text.
- indent(self, text, prefix=' ')
- Indent text by prepending a given prefix to each line.
Methods inherited from pydoc.Doc:
- document(self, object, name=None, *args)
- Generate documentation for an object.
- fail(self, object, name=None, *args)
- Raise an exception for unimplemented types.
- getdocloc(self, object, basedir='/home/schwitrs/xplor/python/bin.Linux_x86_64/lib/python3.11')
- Return the location of module docs or None
Data descriptors inherited from pydoc.Doc:
- __dict__
dictionary for instance variables (if defined)
- __weakref__
list of weak references to the object (if defined)
Data and other attributes inherited from pydoc.Doc:
- PYTHONDOCS = 'https://docs.python.org/3.11/library'
| |
