Home | Trees | Indices | Help |
|
---|
|
|
|||
|
|||
string
|
|
||
1. Interface Methods | |||
---|---|---|---|
None
|
|
||
|
|||
None
|
|
||
2.1. Module Pages | |||
|
|||
2.??. Source Code Pages | |||
|
|||
2.2. Class Pages | |||
|
|||
2.3. Trees pages | |||
|
|||
|
|||
|
|||
2.4. Index pages | |||
|
|||
|
|||
|
|||
|
|||
2.5. Help Page | |||
|
|||
2.6. Frames-based Table of Contents | |||
|
|||
|
|||
|
|||
|
|||
|
|||
2.7. Project homepage (index.html) | |||
|
|||
|
|||
2.8. Stylesheet (epydoc.css) | |||
None
|
|
||
2.9. Javascript (epydoc.js) | |||
|
|||
2.10. Graphs | |||
|
|||
str
|
|
||
str
|
|
||
2.11. Images | |||
|
|||
3.1. Page Header | |||
|
|||
3.2. Page Footer | |||
|
|||
3.3. Navigation Bar | |||
|
|||
3.4. Breadcrumbs | |||
|
|||
|
|||
|
|||
3.5. Summary Tables | |||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
3.6. Details Lists | |||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
Base Tree | |||
string
|
|
||
int
|
|
||
|
|||
Function Signatures | |||
str
|
|
||
str
|
|
||
|
|||
|
|||
Import Lists | |||
|
|||
|
|||
Module Trees | |||
|
|||
|
|||
Class trees | |||
|
|||
Standard Fields | |||
|
|||
|
|||
Index generation | |||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
Redirect page | |||
|
|||
|
|||
URLs list | |||
|
|||
|
|||
Helper functions | |||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|
|||
2.4. Index pages | |||
---|---|---|---|
SPLIT_IDENT_INDEX_SIZE = 3000 If the identifier index has more than this number of entries, then it will be split into separate pages, one for each alphabetical section. |
|||
LETTERS =
The alphabetical sections that are used for link index pages. |
|||
2.9. Javascript (epydoc.js) | |||
TOGGLE_PRIVATE_JS =
A javascript that is used to show or hide the API documentation for private objects. |
|||
GET_COOKIE_JS =
A javascript that is used to read the value of a cookie. |
|||
SET_FRAME_JS =
A javascript that is used to set the contents of two frames at once. |
|||
HIDE_PRIVATE_JS =
A javascript that is used to hide private variables, unless either: (a) the cookie says not to; or (b) we appear to be linking to a private variable. |
|||
TOGGLE_CALLGRAPH_JS =
|
|||
GET_ANCHOR_JS =
|
|||
REDIRECT_URL_JS =
A javascript that is used to implement the auto-redirect page. |
|||
2.10. Graphs | |||
RE_CALLGRAPH_ID = re.compile(r'
|
|||
2.11. Images | |||
IMAGES =
|
|||
3.6. Details Lists | |||
SPECIAL_METHODS =
|
|||
Index generation | |||
METADATA_INDICES =
A list of metadata indices that should be generated. |
|||
Helper functions | |||
TABLE_FOOTER =
|
|||
PRIVATE_LINK =
|
|||
_url_cache =
|
|
|||
_show_private Should private docs be included? |
|||
_prj_name The project's name (for the project link in the navbar) |
|||
_prj_url URL for the project link in the navbar |
|||
_prj_link HTML code for the project link in the navbar |
|||
_top_page The 'main' page |
|||
_css CSS stylesheet to use |
|||
_helpfile Filename of file to extract help contents from |
|||
_frames_index Should a frames index be created? |
|||
_show_imports Should imports be listed? |
|||
_propfunc_linelen [XXX] Not used! |
|||
_variable_maxlines Max lines for variable values |
|||
_variable_linelen Max line length for variable values |
|||
_variable_summary_linelen Max length for variable value summaries |
|||
_variable_tooltip_linelen Max length for variable tooltips |
|||
_inheritance How should inheritance be displayed? 'listed', 'included', or 'grouped' |
|||
_incl_sourcecode Should pages be generated for source code of modules? |
|||
_mark_docstrings Wrap <span class='docstring'>...</span> around docstrings? |
|||
_graph_types Graphs that we should include in our output. |
|||
_include_log Are we generating an HTML log page? |
|||
_callgraph_cache Map the callgraph uid to their HTML representation. |
|||
module_list The list of ModuleDocs for the documented modules. |
|||
module_set The set of ModuleDocs for the documented modules. |
|||
class_list The list of ClassDocs for the documented classes. |
|||
class_set The set of ClassDocs for the documented classes. |
|||
routine_list The list of RoutineDocs for the documented routines. |
|||
indexed_docs The list of APIDocs for variables and values that should be included in the index. |
|
|
index.html .
|
|
out .
|
out .
|
To Do: For multiple inheritance, don't repeat subclasses the second time a class is mentioned; instead, link to the first mention. |
self._helpfile contains a help file, then use it; otherwise,
use the default helpfile from epydoc.docwriter.html_help.
|
|
index.html file in the given directory. The
contents of this file are copied or linked from an existing page, so this
method must be called after all pages have been written. The page used
is determined by _frames_index and _top_page:
|
cssname contains a stylesheet file or name (from epydoc.docwriter.html_css), then use that stylesheet;
otherwise, use the default stylesheet.
|
Render the HTML chunk of a callgraph. Ifcallgraph is a string, use the _callgraph_cache to return a pre-rendered HTML chunk.
This mostly avoids to run dot twice for the same callgraph.
Else, run the graph and store its HTML output in the cache.
|
Render the HTML chunk of a callgraph link. The link can toggles the visibility of the callgraph rendered using render_callgraph with matching parameters. |
out . title is a string containing the page
title. It should be appropriately escaped/encoded.
|
out . The navigation bar typically looks like:
[ Home Trees Index Help Project ]
|
out . The breadcrumbs line is an invisible table with a list
of pointers to the current object's ancestors on the left; and the
show/hide private selector and the frames/noframes selector on the
right.
|
out . A summary table is a table that includes a one-row
description for each variable (of a given type) in a module or class.
|
out . See write_summary_table for more information.
|
|
|
|
|
|
@author and
@todo fields).
|
|
|
VariableDoc , a ValueDoc , or a
DottedName . If a NamespaceDoc
context is specified, the target label is contextualized to
it.
|
|
TOGGLE_PRIVATE_JSA javascript that is used to show or hide the API documentation for private objects. In order for this to work correctly, all documentation for private objects should be enclosed in<div
class="private">...</div> elements.
|
GET_COOKIE_JSA javascript that is used to read the value of a cookie. This is used to remember whether private variables should be shown or hidden.
|
SET_FRAME_JSA javascript that is used to set the contents of two frames at once. This is used by the project table-of-contents frame to set both the module table-of-contents frame and the main frame when the user clicks on a module.
|
HIDE_PRIVATE_JSA javascript that is used to hide private variables, unless either: (a) the cookie says not to; or (b) we appear to be linking to a private variable.
|
TOGGLE_CALLGRAPH_JS
|
GET_ANCHOR_JS
|
REDIRECT_URL_JSA javascript that is used to implement the auto-redirect page. When the user visits <redirect.html#dotted.name>, they will automatically get redirected to the page for the object with the given fully-qualified dotted name. E.g., for epydoc, <redirect.html#epydoc.apidoc.UNKNOWN> redirects the user to <epydoc.apidoc-module.html#UNKNOWN>.
|
IMAGES
|
SPECIAL_METHODS
|
METADATA_INDICESA list of metadata indices that should be generated. Each entry in this list is a tuple(tag, label, short_label) , where
tag is the cannonical tag of a metadata field;
label is a label for the index page; and
short_label is a shorter label, used in the index
selector.
|
PRIVATE_LINK
|
_url_cache
|
Home | Trees | Indices | Help |
|
---|
Generated by Epydoc 3.0beta1 on Thu Mar 1 04:24:50 2007 | http://epydoc.sourceforge.net |