Home | Trees | Indices | Help |
|
---|
|
The documentation information for each individual object is represented using an APIDoc; and the documentation for a collection of objects is represented using a DocIndex.
The main interface toepydoc.docbuilder
consists of two
functions:
|
|||
BuildOptions Holds the parameters for a documentation building process. |
|||
_ProgressEstimator Used to keep track of progress when generating the initial docs for the given items. |
|
|||
|
|||
Documentation Construction | |||
---|---|---|---|
APIDoc |
|
||
DocIndex |
|
||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
Merging | |||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
Linking | |||
|
|||
Naming | |||
|
|||
|
|||
|
|||
|
|||
Inheritance | |||
|
|||
|
|
|||
_INHERITED_ATTRIBS =
|
|||
Merging | |||
---|---|---|---|
MERGE_PRECEDENCE =
Indicates whether information from introspection or parsing should be given precedence, for specific attributes. |
|||
DEFAULT_MERGE_PRECEDENCE =
Indicates whether information from introspection or parsing should be given precedence. |
|||
_attribute_mergefunc_registry = {}
|
|||
Naming | |||
_name_scores =
A dictionary mapping from each ValueDoc to the score
that has been assigned to its current cannonical name.
|
|||
_unreachable_names =
The set of names that have been used for unreachable objects. |
|
|
|
|
APIDoc s.
|
Merge the API documentation information that was obtained from
introspection with information that was obtained from parsing.
introspect_doc and parse_doc are
compatible, then they will be merged -- i.e., they will be coerced
to a common class, and their state will be stored in a shared dictionary.
Once they have been merged, any change made to the attributes of one will
affect the other. The value for the each of the merged
APIDoc 's attributes is formed by combining the values of the
source APIDoc s' attributes, as follows:
introspect_doc and parse_doc are
not compatible (e.g., if their values have incompatible types),
then merge_docs() will simply return either
introspect_doc or parse_doc , depending on the
value of DEFAULT_MERGE_PRECEDENCE. The two input
APIDoc s will not be merged or modified in any way.
|
val_doc (if it doesn't have
one already), and (recursively) to each variable in val_doc .
In particular, val_doc will be assigned the canonical name
name iff either:
None ; but these should be harmless.
|
|
MERGE_PRECEDENCEIndicates whether information from introspection or parsing should be given precedence, for specific attributes. This dictionary maps from attribute names to either'introspect' or
'parse' .
|
DEFAULT_MERGE_PRECEDENCEIndicates whether information from introspection or parsing should be given precedence. Should be either'introspect' or
'parse'
|
_name_scoresA dictionary mapping from eachValueDoc to the score that
has been assigned to its current cannonical name. If assign_canonical_names() finds a canonical name with a
better score, then it will replace the old name.
|
_unreachable_namesThe set of names that have been used for unreachable objects. This is used to ensure there are no duplicate cannonical names assigned._unreachable_names is a dictionary mapping from dotted names
to integer ids, where the next unused unreachable name derived from
dotted name n is DottedName('%s-%s' % (n,
str(_unreachable_names[n]+1))
|
_INHERITED_ATTRIBS
|
Home | Trees | Indices | Help |
|
---|
Generated by Epydoc 3.0beta1 on Thu Mar 1 04:22:37 2007 | http://epydoc.sourceforge.net |