class Documentable: (source)
Known subclasses: pydoctor.model.CanContainImportsDocumentable
, pydoctor.model.Inheritable
, pydoctor.test.test_sphinx.UnknownType
An object that can be documented.
The interface is a bit ridiculously wide.
Method | __init__ |
Undocumented |
Method | __repr__ |
Undocumented |
Method | docsources |
Objects that can be considered as a source of documentation. |
Method | expand |
Return a fully qualified name for the possibly-dotted `name`. |
Method | full |
Undocumented |
Method | reparent |
Undocumented |
Method | report |
Log an error or warning about this documentable object. |
Method | resolve |
Return the object named by "name" (using Python's lookup rules) in this context, if any is known to pydoctor. |
Method | set |
Undocumented |
Method | set |
Undocumented |
Method | setup |
Undocumented |
Class Variable | kind |
Page location where we are documented. |
Class Variable | parsed |
Undocumented |
Class Variable | parsed |
Undocumented |
Class Variable | parsed |
Undocumented |
Instance Variable | contents |
Undocumented |
Instance Variable | docstring |
The object's docstring. But also see docsources. |
Instance Variable | docstring |
Undocumented |
Instance Variable | extra |
A list to store extra informations about this documentable, as ParsedDocstring . |
Instance Variable | linenumber |
Undocumented |
Instance Variable | name |
Undocumented |
Instance Variable | parent |
Undocumented |
Instance Variable | parent |
Undocumented |
Instance Variable | source |
Undocumented |
Instance Variable | source |
Undocumented |
Instance Variable | system |
The system the object is part of. |
Property | description |
A string describing our source location to the user. |
Property | docstring |
Returns an instance of DocstringLinker suitable for resolving names in the context of the object scope. |
Property | doctarget |
Undocumented |
Property | is |
Is this object considered private API? |
Property | is |
Is this object so private as to be not shown at all? |
Property | module |
This object's Module . |
Property | page |
The documentable to which the page we're documented on belongs. For example methods are documented on the page of their class, functions are documented in their module's page etc. |
Property | privacy |
How visible this object should be. |
Property | url |
Relative URL at which the documentation for this Documentable can be found. |
Method | _handle |
Undocumented |
Method | _handle |
Undocumented |
Method | _local |
Undocumented |
Instance Variable | _linker |
Undocumented |
pydoctor.model.Inheritable
Objects that can be considered as a source of documentation.
The motivating example for having multiple sources is looking at a superclass' implementation of a method for documentation for a subclass'.
Returns | |
Iterator[ | Undocumented |
Return a fully qualified name for the possibly-dotted `name`.
To explain what this means, consider the following modules:
mod1.py:
from external_location import External class Local: pass
mod2.py:
from mod1 import External as RenamedExternal import mod1 as renamed_mod class E: pass
In the context of mod2.E, expandName("RenamedExternal") should be "external_location.External" and expandName("renamed_mod.Local") should be "mod1.Local".
Parameters | |
name:str | Undocumented |
Returns | |
str | Undocumented |
Log an error or warning about this documentable object.
Parameters | |
descr:str | The error/warning string |
section:str | What the warning is about. |
linenoint | Offset |
thresh:int | Thresh to pass to System.msg , it will use -1 by default, meaning it will count as a violation and will fail the build if option -W is passed. But this behaviour is not applicable if thresh is greater or equal to zero. |
Return the object named by "name" (using Python's lookup rules) in this context, if any is known to pydoctor.
Parameters | |
name:str | Undocumented |
Returns | |
Optional[ | Undocumented |
A string describing our source location to the user.
If this module's code was read from a file, this returns its file path. In other cases, such as during unit testing, the full module name is returned.
Returns an instance of DocstringLinker
suitable for resolving names in the context of the object scope.
Is this object considered private API?
This is just a simple helper which defers to self.privacyClass.
Is this object so private as to be not shown at all?
This is just a simple helper which defers to self.privacyClass.
pydoctor.model.Module
This object's Module
.
For modules, this returns the object itself, otherwise the module containing the object is returned.
The documentable to which the page we're documented on belongs. For example methods are documented on the page of their class, functions are documented in their module's page etc.
Relative URL at which the documentation for this Documentable can be found.
For page objects this method MUST return an .html filename without a URI fragment (because pydoctor.templatewriter.writer.TemplateWriter
uses it directly to determine the output filename).