From 6d231a93982ac7f5541ee77bf8aa9fadfe6617a3 Mon Sep 17 00:00:00 2001 From: Jarrod Millman Date: Sun, 23 Sep 2007 14:36:47 +0000 Subject: one more try --- numpy/doc/html/api-objects.txt | 4 + numpy/doc/html/crarr.png | Bin 0 -> 340 bytes numpy/doc/html/epydoc.css | 315 +++++++++++++++++++++++++++++++ numpy/doc/html/epydoc.js | 280 ++++++++++++++++++++++++++++ numpy/doc/html/example-module.html | 328 +++++++++++++++++++++++++++++++++ numpy/doc/html/example-pysrc.html | 208 +++++++++++++++++++++ numpy/doc/html/frames.html | 17 ++ numpy/doc/html/help.html | 268 +++++++++++++++++++++++++++ numpy/doc/html/identifier-index.html | 180 ++++++++++++++++++ numpy/doc/html/index.html | 17 ++ numpy/doc/html/module-tree.html | 101 ++++++++++ numpy/doc/html/redirect.html | 38 ++++ numpy/doc/html/toc-everything.html | 34 ++++ numpy/doc/html/toc-example-module.html | 34 ++++ numpy/doc/html/toc.html | 34 ++++ 15 files changed, 1858 insertions(+) create mode 100644 numpy/doc/html/api-objects.txt create mode 100644 numpy/doc/html/crarr.png create mode 100644 numpy/doc/html/epydoc.css create mode 100644 numpy/doc/html/epydoc.js create mode 100644 numpy/doc/html/example-module.html create mode 100644 numpy/doc/html/example-pysrc.html create mode 100644 numpy/doc/html/frames.html create mode 100644 numpy/doc/html/help.html create mode 100644 numpy/doc/html/identifier-index.html create mode 100644 numpy/doc/html/index.html create mode 100644 numpy/doc/html/module-tree.html create mode 100644 numpy/doc/html/redirect.html create mode 100644 numpy/doc/html/toc-everything.html create mode 100644 numpy/doc/html/toc-example-module.html create mode 100644 numpy/doc/html/toc.html (limited to 'numpy/doc/html') diff --git a/numpy/doc/html/api-objects.txt b/numpy/doc/html/api-objects.txt new file mode 100644 index 000000000..81953990e --- /dev/null +++ b/numpy/doc/html/api-objects.txt @@ -0,0 +1,4 @@ +example example-module.html +example.otherfunc example-module.html#otherfunc +example.foo example-module.html#foo +example.newfunc example-module.html#newfunc diff --git a/numpy/doc/html/crarr.png b/numpy/doc/html/crarr.png new file mode 100644 index 000000000..26b43c524 Binary files /dev/null and b/numpy/doc/html/crarr.png differ diff --git a/numpy/doc/html/epydoc.css b/numpy/doc/html/epydoc.css new file mode 100644 index 000000000..4bb3e0b68 --- /dev/null +++ b/numpy/doc/html/epydoc.css @@ -0,0 +1,315 @@ + + +/* Epydoc CSS Stylesheet + * + * This stylesheet can be used to customize the appearance of epydoc's + * HTML output. + * + */ + +/* Default Colors & Styles + * - Set the default foreground & background color with 'body'; and + * link colors with 'a:link' and 'a:visited'. + * - Use bold for decision list terms. + * - The heading styles defined here are used for headings *within* + * docstring descriptions. All headings used by epydoc itself use + * either class='epydoc' or class='toc' (CSS styles for both + * defined below). + */ +body { background: #ffffff; color: #000000; } +p { margin-top: 0.5em; margin-bottom: 0.5em; } +a:link { color: #0000ff; } +a:visited { color: #204080; } +dt { font-weight: bold; } +h1 { font-size: +140%; font-style: italic; + font-weight: bold; } +h2 { font-size: +125%; font-style: italic; + font-weight: bold; } +h3 { font-size: +110%; font-style: italic; + font-weight: normal; } +code { font-size: 100%; } + +/* Page Header & Footer + * - The standard page header consists of a navigation bar (with + * pointers to standard pages such as 'home' and 'trees'); a + * breadcrumbs list, which can be used to navigate to containing + * classes or modules; options links, to show/hide private + * variables and to show/hide frames; and a page title (using + *

). The page title may be followed by a link to the + * corresponding source code (using 'span.codelink'). + * - The footer consists of a navigation bar, a timestamp, and a + * pointer to epydoc's homepage. + */ +h1.epydoc { margin: 0; font-size: +140%; font-weight: bold; } +h2.epydoc { font-size: +130%; font-weight: bold; } +h3.epydoc { font-size: +115%; font-weight: bold; + margin-top: 0.2em; } +td h3.epydoc { font-size: +115%; font-weight: bold; + margin-bottom: 0; } +table.navbar { background: #a0c0ff; color: #000000; + border: 2px groove #c0d0d0; } +table.navbar table { color: #000000; } +th.navbar-select { background: #70b0ff; + color: #000000; } +table.navbar a { text-decoration: none; } +table.navbar a:link { color: #0000ff; } +table.navbar a:visited { color: #204080; } +span.breadcrumbs { font-size: 85%; font-weight: bold; } +span.options { font-size: 70%; } +span.codelink { font-size: 85%; } +td.footer { font-size: 85%; } + +/* Table Headers + * - Each summary table and details section begins with a 'header' + * row. This row contains a section title (marked by + * 'span.table-header') as well as a show/hide private link + * (marked by 'span.options', defined above). + * - Summary tables that contain user-defined groups mark those + * groups using 'group header' rows. + */ +td.table-header { background: #70b0ff; color: #000000; + border: 1px solid #608090; } +td.table-header table { color: #000000; } +td.table-header table a:link { color: #0000ff; } +td.table-header table a:visited { color: #204080; } +span.table-header { font-size: 120%; font-weight: bold; } +th.group-header { background: #c0e0f8; color: #000000; + text-align: left; font-style: italic; + font-size: 115%; + border: 1px solid #608090; } + +/* Summary Tables (functions, variables, etc) + * - Each object is described by a single row of the table with + * two cells. The left cell gives the object's type, and is + * marked with 'code.summary-type'. The right cell gives the + * object's name and a summary description. + * - CSS styles for the table's header and group headers are + * defined above, under 'Table Headers' + */ +table.summary { border-collapse: collapse; + background: #e8f0f8; color: #000000; + border: 1px solid #608090; + margin-bottom: 0.5em; } +td.summary { border: 1px solid #608090; } +code.summary-type { font-size: 85%; } +table.summary a:link { color: #0000ff; } +table.summary a:visited { color: #204080; } + + +/* Details Tables (functions, variables, etc) + * - Each object is described in its own div. + * - A single-row summary table w/ table-header is used as + * a header for each details section (CSS style for table-header + * is defined above, under 'Table Headers'). + */ +table.details { border-collapse: collapse; + background: #e8f0f8; color: #000000; + border: 1px solid #608090; + margin: .2em 0 0 0; } +table.details table { color: #000000; } +table.details a:link { color: #0000ff; } +table.details a:visited { color: #204080; } + +/* Fields */ +dl.fields { margin-left: 2em; margin-top: 1em; + margin-bottom: 1em; } +dl.fields dd ul { margin-left: 0em; padding-left: 0em; } +dl.fields dd ul li ul { margin-left: 2em; padding-left: 0em; } +div.fields { margin-left: 2em; } +div.fields p { margin-bottom: 0.5em; } + +/* Index tables (identifier index, term index, etc) + * - link-index is used for indices containing lists of links + * (namely, the identifier index & term index). + * - index-where is used in link indices for the text indicating + * the container/source for each link. + * - metadata-index is used for indices containing metadata + * extracted from fields (namely, the bug index & todo index). + */ +table.link-index { border-collapse: collapse; + background: #e8f0f8; color: #000000; + border: 1px solid #608090; } +td.link-index { border-width: 0px; } +table.link-index a:link { color: #0000ff; } +table.link-index a:visited { color: #204080; } +span.index-where { font-size: 70%; } +table.metadata-index { border-collapse: collapse; + background: #e8f0f8; color: #000000; + border: 1px solid #608090; + margin: .2em 0 0 0; } +td.metadata-index { border-width: 1px; border-style: solid; } +table.metadata-index a:link { color: #0000ff; } +table.metadata-index a:visited { color: #204080; } + +/* Function signatures + * - sig* is used for the signature in the details section. + * - .summary-sig* is used for the signature in the summary + * table, and when listing property accessor functions. + * */ +.sig-name { color: #006080; } +.sig-arg { color: #008060; } +.sig-default { color: #602000; } +.summary-sig { font-family: monospace; } +.summary-sig-name { color: #006080; font-weight: bold; } +table.summary a.summary-sig-name:link + { color: #006080; font-weight: bold; } +table.summary a.summary-sig-name:visited + { color: #006080; font-weight: bold; } +.summary-sig-arg { color: #006040; } +.summary-sig-default { color: #501800; } + +/* To render variables, classes etc. like functions */ +table.summary .summary-name { color: #006080; font-weight: bold; + font-family: monospace; } +table.summary + a.summary-name:link { color: #006080; font-weight: bold; + font-family: monospace; } +table.summary + a.summary-name:visited { color: #006080; font-weight: bold; + font-family: monospace; } + +/* Variable values + * - In the 'variable details' sections, each varaible's value is + * listed in a 'pre.variable' box. The width of this box is + * restricted to 80 chars; if the value's repr is longer than + * this it will be wrapped, using a backslash marked with + * class 'variable-linewrap'. If the value's repr is longer + * than 3 lines, the rest will be ellided; and an ellipsis + * marker ('...' marked with 'variable-ellipsis') will be used. + * - If the value is a string, its quote marks will be marked + * with 'variable-quote'. + * - If the variable is a regexp, it is syntax-highlighted using + * the re* CSS classes. + */ +pre.variable { padding: .5em; margin: 0; + background: #dce4ec; color: #000000; + border: 1px solid #708890; } +.variable-linewrap { color: #604000; font-weight: bold; } +.variable-ellipsis { color: #604000; font-weight: bold; } +.variable-quote { color: #604000; font-weight: bold; } +.variable-group { color: #008000; font-weight: bold; } +.variable-op { color: #604000; font-weight: bold; } +.variable-string { color: #006030; } +.variable-unknown { color: #a00000; font-weight: bold; } +.re { color: #000000; } +.re-char { color: #006030; } +.re-op { color: #600000; } +.re-group { color: #003060; } +.re-ref { color: #404040; } + +/* Base tree + * - Used by class pages to display the base class hierarchy. + */ +pre.base-tree { font-size: 80%; margin: 0; } + +/* Frames-based table of contents headers + * - Consists of two frames: one for selecting modules; and + * the other listing the contents of the selected module. + * - h1.toc is used for each frame's heading + * - h2.toc is used for subheadings within each frame. + */ +h1.toc { text-align: center; font-size: 105%; + margin: 0; font-weight: bold; + padding: 0; } +h2.toc { font-size: 100%; font-weight: bold; + margin: 0.5em 0 0 -0.3em; } + +/* Syntax Highlighting for Source Code + * - doctest examples are displayed in a 'pre.py-doctest' block. + * If the example is in a details table entry, then it will use + * the colors specified by the 'table pre.py-doctest' line. + * - Source code listings are displayed in a 'pre.py-src' block. + * Each line is marked with 'span.py-line' (used to draw a line + * down the left margin, separating the code from the line + * numbers). Line numbers are displayed with 'span.py-lineno'. + * The expand/collapse block toggle button is displayed with + * 'a.py-toggle' (Note: the CSS style for 'a.py-toggle' should not + * modify the font size of the text.) + * - If a source code page is opened with an anchor, then the + * corresponding code block will be highlighted. The code + * block's header is highlighted with 'py-highlight-hdr'; and + * the code block's body is highlighted with 'py-highlight'. + * - The remaining py-* classes are used to perform syntax + * highlighting (py-string for string literals, py-name for names, + * etc.) + */ +pre.py-doctest { padding: .5em; margin: 1em; + background: #e8f0f8; color: #000000; + border: 1px solid #708890; } +table pre.py-doctest { background: #dce4ec; + color: #000000; } +pre.py-src { border: 2px solid #000000; + background: #f0f0f0; color: #000000; } +.py-line { border-left: 2px solid #000000; + margin-left: .2em; padding-left: .4em; } +.py-lineno { font-style: italic; font-size: 90%; + padding-left: .5em; } +a.py-toggle { text-decoration: none; } +div.py-highlight-hdr { border-top: 2px solid #000000; + border-bottom: 2px solid #000000; + background: #d8e8e8; } +div.py-highlight { border-bottom: 2px solid #000000; + background: #d0e0e0; } +.py-prompt { color: #005050; font-weight: bold;} +.py-more { color: #005050; font-weight: bold;} +.py-string { color: #006030; } +.py-comment { color: #003060; } +.py-keyword { color: #600000; } +.py-output { color: #404040; } +.py-name { color: #000050; } +.py-name:link { color: #000050 !important; } +.py-name:visited { color: #000050 !important; } +.py-number { color: #005000; } +.py-defname { color: #000060; font-weight: bold; } +.py-def-name { color: #000060; font-weight: bold; } +.py-base-class { color: #000060; } +.py-param { color: #000060; } +.py-docstring { color: #006030; } +.py-decorator { color: #804020; } +/* Use this if you don't want links to names underlined: */ +/*a.py-name { text-decoration: none; }*/ + +/* Graphs & Diagrams + * - These CSS styles are used for graphs & diagrams generated using + * Graphviz dot. 'img.graph-without-title' is used for bare + * diagrams (to remove the border created by making the image + * clickable). + */ +img.graph-without-title { border: none; } +img.graph-with-title { border: 1px solid #000000; } +span.graph-title { font-weight: bold; } +span.graph-caption { } + +/* General-purpose classes + * - 'p.indent-wrapped-lines' defines a paragraph whose first line + * is not indented, but whose subsequent lines are. + * - The 'nomargin-top' class is used to remove the top margin (e.g. + * from lists). The 'nomargin' class is used to remove both the + * top and bottom margin (but not the left or right margin -- + * for lists, that would cause the bullets to disappear.) + */ +p.indent-wrapped-lines { padding: 0 0 0 7em; text-indent: -7em; + margin: 0; } +.nomargin-top { margin-top: 0; } +.nomargin { margin-top: 0; margin-bottom: 0; } + +/* HTML Log */ +div.log-block { padding: 0; margin: .5em 0 .5em 0; + background: #e8f0f8; color: #000000; + border: 1px solid #000000; } +div.log-error { padding: .1em .3em .1em .3em; margin: 4px; + background: #ffb0b0; color: #000000; + border: 1px solid #000000; } +div.log-warning { padding: .1em .3em .1em .3em; margin: 4px; + background: #ffffb0; color: #000000; + border: 1px solid #000000; } +div.log-info { padding: .1em .3em .1em .3em; margin: 4px; + background: #b0ffb0; color: #000000; + border: 1px solid #000000; } +h2.log-hdr { background: #70b0ff; color: #000000; + margin: 0; padding: 0em 0.5em 0em 0.5em; + border-bottom: 1px solid #000000; font-size: 110%; } +p.log { font-weight: bold; margin: .5em 0 .5em 0; } +tr.opt-changed { color: #000000; font-weight: bold; } +tr.opt-default { color: #606060; } +pre.log { margin: 0; padding: 0; padding-left: 1em; } diff --git a/numpy/doc/html/epydoc.js b/numpy/doc/html/epydoc.js new file mode 100644 index 000000000..b5b2ddc40 --- /dev/null +++ b/numpy/doc/html/epydoc.js @@ -0,0 +1,280 @@ +function toggle_private() { + // Search for any private/public links on this page. Store + // their old text in "cmd," so we will know what action to + // take; and change their text to the opposite action. + var cmd = "?"; + var elts = document.getElementsByTagName("a"); + for(var i=0; i...
"; + elt.innerHTML = s; + } +} + +function toggle(id) { + elt = document.getElementById(id+"-toggle"); + if (elt.innerHTML == "-") + collapse(id); + else + expand(id); + return false; +} + +function highlight(id) { + var elt = document.getElementById(id+"-def"); + if (elt) elt.className = "py-highlight-hdr"; + var elt = document.getElementById(id+"-expanded"); + if (elt) elt.className = "py-highlight"; + var elt = document.getElementById(id+"-collapsed"); + if (elt) elt.className = "py-highlight"; +} + +function num_lines(s) { + var n = 1; + var pos = s.indexOf("\n"); + while ( pos > 0) { + n += 1; + pos = s.indexOf("\n", pos+1); + } + return n; +} + +// Collapse all blocks that mave more than `min_lines` lines. +function collapse_all(min_lines) { + var elts = document.getElementsByTagName("div"); + for (var i=0; i 0) + if (elt.id.substring(split, elt.id.length) == "-expanded") + if (num_lines(elt.innerHTML) > min_lines) + collapse(elt.id.substring(0, split)); + } +} + +function expandto(href) { + var start = href.indexOf("#")+1; + if (start != 0 && start != href.length) { + if (href.substring(start, href.length) != "-") { + collapse_all(4); + pos = href.indexOf(".", start); + while (pos != -1) { + var id = href.substring(start, pos); + expand(id); + pos = href.indexOf(".", pos+1); + } + var id = href.substring(start, href.length); + expand(id); + highlight(id); + } + } +} + +function kill_doclink(id) { + var parent = document.getElementById(id); + parent.removeChild(parent.childNodes.item(0)); +} +function auto_kill_doclink(ev) { + if (!ev) var ev = window.event; + if (!this.contains(ev.toElement)) { + var parent = document.getElementById(this.parentID); + parent.removeChild(parent.childNodes.item(0)); + } +} + +function doclink(id, name, targets_id) { + var elt = document.getElementById(id); + + // If we already opened the box, then destroy it. + // (This case should never occur, but leave it in just in case.) + if (elt.childNodes.length > 1) { + elt.removeChild(elt.childNodes.item(0)); + } + else { + // The outer box: relative + inline positioning. + var box1 = document.createElement("div"); + box1.style.position = "relative"; + box1.style.display = "inline"; + box1.style.top = 0; + box1.style.left = 0; + + // A shadow for fun + var shadow = document.createElement("div"); + shadow.style.position = "absolute"; + shadow.style.left = "-1.3em"; + shadow.style.top = "-1.3em"; + shadow.style.background = "#404040"; + + // The inner box: absolute positioning. + var box2 = document.createElement("div"); + box2.style.position = "relative"; + box2.style.border = "1px solid #a0a0a0"; + box2.style.left = "-.2em"; + box2.style.top = "-.2em"; + box2.style.background = "white"; + box2.style.padding = ".3em .4em .3em .4em"; + box2.style.fontStyle = "normal"; + box2.onmouseout=auto_kill_doclink; + box2.parentID = id; + + // Get the targets + var targets_elt = document.getElementById(targets_id); + var targets = targets_elt.getAttribute("targets"); + var links = ""; + target_list = targets.split(","); + for (var i=0; i" + + target[0] + ""; + } + + // Put it all together. + elt.insertBefore(box1, elt.childNodes.item(0)); + //box1.appendChild(box2); + box1.appendChild(shadow); + shadow.appendChild(box2); + box2.innerHTML = + "Which "+name+" do you want to see documentation for?" + + ""; + } + return false; +} + +function get_anchor() { + var href = location.href; + var start = href.indexOf("#")+1; + if ((start != 0) && (start != href.length)) + return href.substring(start, href.length); + } +function redirect_url(dottedName) { + // Scan through each element of the "pages" list, and check + // if "name" matches with any of them. + for (var i=0; i-m" or "-c"; + // extract the portion & compare it to dottedName. + var pagename = pages[i].substring(0, pages[i].length-2); + if (pagename == dottedName.substring(0,pagename.length)) { + + // We've found a page that matches `dottedName`; + // construct its URL, using leftover `dottedName` + // content to form an anchor. + var pagetype = pages[i].charAt(pages[i].length-1); + var url = pagename + ((pagetype=="m")?"-module.html": + "-class.html"); + if (dottedName.length > pagename.length) + url += "#" + dottedName.substring(pagename.length+1, + dottedName.length); + return url; + } + } + } diff --git a/numpy/doc/html/example-module.html b/numpy/doc/html/example-module.html new file mode 100644 index 000000000..e457b5c8d --- /dev/null +++ b/numpy/doc/html/example-module.html @@ -0,0 +1,328 @@ + + + + + example + + + + + + + + + + + + + + + + + + + + + + +
   Home      Trees      Indices      Help   
+ + + + + +
+ + Module example + + + + + + +
[hide private]
[frames] | no frames]
+
+ +

Module example

source code

+
+This is the docstring for the example.py module.  Modules names should
+have short, all-lowercase names.  The module name may have underscores if
+this improves readability.
+
+Every module should have a docstring at the very top of the file.  The
+module's docstring may extend over multiple lines.  If your docstring does
+extend over multiple lines, the closing three quotation marks must be on
+a line by itself, preferably preceeded by a blank line.
+
+
+ + + + + + + + + + + + + + + + +
+ + + + + +
Functions[hide private]
+
+   + + + + + + +
foo(var1, + var2, + long_var_name='hi')
+ One-line summary or signature.		 + source code + +
+ +
+   + + + + + + +
newfunc()
+ Do nothing.		 + source code + +
+ +
+   + + + + + + +
otherfunc()
+ Do nothing.		 + source code + +
+ +
+ + + + + + +
+ + + + + +
Function Details[hide private]
+
+ +
+ +
+ + +
+

foo(var1, + var2, + long_var_name='hi') +

+ 		source code  +
+ + 
+One-line summary or signature.
+
+Several sentences providing an extended description. You can put
+text in mono-spaced type like so: ``var``.
+
+*Parameters*:
+
+    var1 : {array_like}
+        Array_like means all those objects -- lists, nested lists, etc. --
+        that can be converted to an array.
+    var2 : {integer}
+        Write out the full type
+    long_variable_name : {'hi', 'ho'}, optional
+        Choices in brackets, default first when optional.
+
+*Returns*:
+
+    named : {type}
+        Explanation
+    list
+        Explanation
+    of
+        Explanation
+    outputs
+        even more explaining
+
+*Other Parameters*:
+
+    only_seldom_used_keywords : type
+        Explanation
+    common_parametrs_listed_above : type
+        Explanation
+
+*See Also*:
+
+    `otherfunc` : relationship (optional)
+
+    `newfunc` : relationship (optional)
+
+*Notes*
+
+    Notes about the implementation algorithm (if needed).
+
+    This can have multiple paragraphs as can all sections.
+
+*Examples*
+
+    examples in doctest format
+
+    >>> a=[1,2,3]
+    >>> [x + 3 for x in a]
+    [4, 5, 6]
+
+
+
+
+
+
+ +
+ +
+ + +
+

newfunc() +

+ 		source code  +
+ + 
+Do nothing.
+
+I never saw a purple cow.
+
+
+
+
+
+
+ +
+ +
+ + +
+

otherfunc() +

+ 		source code  +
+ + 
+Do nothing.
+
+I never hope to see one.
+
+
+
+
+
+
+
+ + + + + + + + + + + + + + + + + +
   Home      Trees      Indices      Help   
+ + + + + +
+ Generated by Epydoc 3.0beta1 on Sun Sep 23 07:36:32 2007 + + http://epydoc.sourceforge.net +
+ + + + + diff --git a/numpy/doc/html/example-pysrc.html b/numpy/doc/html/example-pysrc.html new file mode 100644 index 000000000..f1b8bfba5 --- /dev/null +++ b/numpy/doc/html/example-pysrc.html @@ -0,0 +1,208 @@ + + + + + example + + + + + + + + + + + + + + + + + + + + + + +
   Home      Trees      Indices      Help   
+ + + + + +
+ + Module example + + + + + + +
[hide private]
[frames] | no frames]
+
+

Source Code for Module example

+
+  1  """This is the docstring for the example.py module.  Modules names should 
+  2  have short, all-lowercase names.  The module name may have underscores if 
+  3  this improves readability. 
+  4   
+  5  Every module should have a docstring at the very top of the file.  The 
+  6  module's docstring may extend over multiple lines.  If your docstring does 
+  7  extend over multiple lines, the closing three quotation marks must be on 
+  8  a line by itself, preferably preceeded by a blank line. 
+  9   
+ 10  """ 
+ 11   
+ 12  import os                      # standard library imports first 
+ 13   
+ 14  import numpy as np             # related third party imports next 
+ 15  import scipy as sp             # imports should be at the top of the module 
+ 16  import matplotlib as mpl       # imports should usually be on separate lines 
+ 17   
+ 18   
+ 19  __docformat__ = "restructuredtext en" 
+ 20   
+ 21   
+
 22 -def foo(var1, var2, long_var_name='hi') : 
+
 23      """One-line summary or signature. 
+ 24   
+ 25      Several sentences providing an extended description. You can put 
+ 26      text in mono-spaced type like so: ``var``. 
+ 27   
+ 28      *Parameters*: 
+ 29   
+ 30          var1 : {array_like} 
+ 31              Array_like means all those objects -- lists, nested lists, etc. -- 
+ 32              that can be converted to an array. 
+ 33          var2 : {integer} 
+ 34              Write out the full type 
+ 35          long_variable_name : {'hi', 'ho'}, optional 
+ 36              Choices in brackets, default first when optional. 
+ 37   
+ 38      *Returns*: 
+ 39   
+ 40          named : {type} 
+ 41              Explanation 
+ 42          list 
+ 43              Explanation 
+ 44          of 
+ 45              Explanation 
+ 46          outputs 
+ 47              even more explaining 
+ 48   
+ 49      *Other Parameters*: 
+ 50   
+ 51          only_seldom_used_keywords : type 
+ 52              Explanation 
+ 53          common_parametrs_listed_above : type 
+ 54              Explanation 
+ 55   
+ 56      *See Also*: 
+ 57   
+ 58          `otherfunc` : relationship (optional) 
+ 59   
+ 60          `newfunc` : relationship (optional) 
+ 61   
+ 62      *Notes* 
+ 63   
+ 64          Notes about the implementation algorithm (if needed). 
+ 65   
+ 66          This can have multiple paragraphs as can all sections. 
+ 67   
+ 68      *Examples* 
+ 69   
+ 70          examples in doctest format 
+ 71   
+ 72          >>> a=[1,2,3] 
+ 73          >>> [x + 3 for x in a] 
+ 74          [4, 5, 6] 
+ 75   
+ 76      """ 
+ 77   
+ 78      pass 
+
 79   
+ 80   
+
 81 -def newfunc() : 
+
 82      """Do nothing. 
+ 83   
+ 84      I never saw a purple cow. 
+ 85   
+ 86      """ 
+ 87   
+ 88      pass 
+
 89   
+ 90   
+
 91 -def otherfunc() : 
+
 92      """Do nothing. 
+ 93   
+ 94      I never hope to see one. 
+ 95   
+ 96      """ 
+ 97   
+ 98      pass 
+
 99   
+
+
+ + + + + + + + + + + + + + + + + +
   Home      Trees      Indices      Help   
+ + + + + +
+ Generated by Epydoc 3.0beta1 on Sun Sep 23 07:36:32 2007 + + http://epydoc.sourceforge.net +
+ + + + + diff --git a/numpy/doc/html/frames.html b/numpy/doc/html/frames.html new file mode 100644 index 000000000..6ebc67e75 --- /dev/null +++ b/numpy/doc/html/frames.html @@ -0,0 +1,17 @@ + + + + + API Documentation + + + + + + + + + diff --git a/numpy/doc/html/help.html b/numpy/doc/html/help.html new file mode 100644 index 000000000..86738e3bf --- /dev/null +++ b/numpy/doc/html/help.html @@ -0,0 +1,268 @@ + + + + + Help + + + + + + + + + + + + + + + + + + + + + + +
   Home      Trees      Indices      Help   
+ + + + + +
  + + + + +
[hide private]
[frames] | no frames]
+
+ +

API Documentation

+ +

This document contains the API (Application Programming Interface) +documentation for this project. Documentation for the Python +objects defined by the project is divided into separate pages for each +package, module, and class. The API documentation also includes two +pages containing information about the project as a whole: a trees +page, and an index page.

+ +

Object Documentation

+ +

Each Package Documentation page contains:

+
    +
  • A description of the package.
    • +
  • A list of the modules and sub-packages contained by the + package.
    • +
  • A summary of the classes defined by the package.
    • +
  • A summary of the functions defined by the package.
    • +
  • A summary of the variables defined by the package.
    • +
  • A detailed description of each function defined by the + package.
    • +
  • A detailed description of each variable defined by the + package.
    • +
+ +

Each Module Documentation page contains:

+
    +
  • A description of the module.
    • +
  • A summary of the classes defined by the module.
    • +
  • A summary of the functions defined by the module.
    • +
  • A summary of the variables defined by the module.
    • +
  • A detailed description of each function defined by the + module.
    • +
  • A detailed description of each variable defined by the + module.
    • +
+ +

Each Class Documentation page contains:

+
    +
  • A class inheritance diagram.
    • +
  • A list of known subclasses.
    • +
  • A description of the class.
    • +
  • A summary of the methods defined by the class.
    • +
  • A summary of the instance variables defined by the class.
    • +
  • A summary of the class (static) variables defined by the + class.
    • +
  • A detailed description of each method defined by the + class.
    • +
  • A detailed description of each instance variable defined by the + class.
    • +
  • A detailed description of each class (static) variable defined + by the class.
    • +
+ +

Project Documentation

+ +

The Trees page contains the module and class hierarchies:

+
    +
  • The module hierarchy lists every package and module, with + modules grouped into packages. At the top level, and within each + package, modules and sub-packages are listed alphabetically.
    • +
  • The class hierarchy lists every class, grouped by base + class. If a class has more than one base class, then it will be + listed under each base class. At the top level, and under each base + class, classes are listed alphabetically.
    • +
+ +

The Index page contains indices of terms and + identifiers:

+
    +
  • The term index lists every term indexed by any object's + documentation. For each term, the index provides links to each + place where the term is indexed.
    • +
  • The identifier index lists the (short) name of every package, + module, class, method, function, variable, and parameter. For each + identifier, the index provides a short description, and a link to + its documentation.
    • +
+ +

The Table of Contents

+ +

The table of contents occupies the two frames on the left side of +the window. The upper-left frame displays the project +contents, and the lower-left frame displays the module +contents:

+ + + + + + + + + +
+ Project
Contents
...		 + API
Documentation
Frame


+
+ Module
Contents
 
...
  +

+ +

The project contents frame contains a list of all packages +and modules that are defined by the project. Clicking on an entry +will display its contents in the module contents frame. Clicking on a +special entry, labeled "Everything," will display the contents of +the entire project.

+ +

The module contents frame contains a list of every +submodule, class, type, exception, function, and variable defined by a +module or package. Clicking on an entry will display its +documentation in the API documentation frame. Clicking on the name of +the module, at the top of the frame, will display the documentation +for the module itself.

+ +

The "frames" and "no frames" buttons below the top +navigation bar can be used to control whether the table of contents is +displayed or not.

+ +

The Navigation Bar

+ +

A navigation bar is located at the top and bottom of every page. +It indicates what type of page you are currently viewing, and allows +you to go to related pages. The following table describes the labels +on the navigation bar. Note that not some labels (such as +[Parent]) are not displayed on all pages.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + +
LabelHighlighted when...Links to...
[Parent](never highlighted) the parent of the current package
[Package]viewing a packagethe package containing the current object +
[Module]viewing a modulethe module containing the current object +
[Class]viewing a class the class containing the current object
[Trees]viewing the trees page the trees page
[Index]viewing the index page the index page
[Help]viewing the help page the help page
+ +

The "show private" and "hide private" buttons below +the top navigation bar can be used to control whether documentation +for private objects is displayed. Private objects are usually defined +as objects whose (short) names begin with a single underscore, but do +not end with an underscore. For example, "_x", +"__pprint", and "epydoc.epytext._tokenize" +are private objects; but "re.sub", +"__init__", and "type_" are not. However, +if a module defines the "__all__" variable, then its +contents are used to decide which objects are private.

+ +

A timestamp below the bottom navigation bar indicates when each +page was last updated.

+ + + + + + + + + + + + + + + + + +
   Home      Trees      Indices      Help   
+ + + + + +
+ Generated by Epydoc 3.0beta1 on Sun Sep 23 07:36:32 2007 + + http://epydoc.sourceforge.net +
+ + + + + diff --git a/numpy/doc/html/identifier-index.html b/numpy/doc/html/identifier-index.html new file mode 100644 index 000000000..84a547ee0 --- /dev/null +++ b/numpy/doc/html/identifier-index.html @@ -0,0 +1,180 @@ + + + + + Identifier Index + + + + + + + + + + + + + + + + + + + + + + +
   Home      Trees      Indices      Help   
+ + + + + +
  + + + + +
[hide private]
[frames] | no frames]
+
+ +
+

Identifier Index

+		 +[ + A + B + C + D + E + F + G + H + I + J + K + L + M + N + O + P + Q + R + S + T + U + V + W + X + Y + Z + _ +] +
+ + + + + + + + + +

E

 + + + + + + + +
example  
   
+

F

 + + + + + + + +
foo()
+(in example)		  
   
+

N

 + + + + + + + +
newfunc()
+(in example)		  
   
+

O

 + + + + + + + +
otherfunc()
+(in example)		  
   
+
+

+ + + + + + + + + + + + + + + + +
   Home      Trees      Indices      Help   
+ + + + + +
+ Generated by Epydoc 3.0beta1 on Sun Sep 23 07:36:32 2007 + + http://epydoc.sourceforge.net +
+ + + + + diff --git a/numpy/doc/html/index.html b/numpy/doc/html/index.html new file mode 100644 index 000000000..6ebc67e75 --- /dev/null +++ b/numpy/doc/html/index.html @@ -0,0 +1,17 @@ + + + + + API Documentation + + + + + + + + + diff --git a/numpy/doc/html/module-tree.html b/numpy/doc/html/module-tree.html new file mode 100644 index 000000000..84bd6de83 --- /dev/null +++ b/numpy/doc/html/module-tree.html @@ -0,0 +1,101 @@ + + + + + Module Hierarchy + + + + + + + + + + + + + + + + + + + + + + +
   Home      Trees      Indices      Help   
+ + + + + +
  + + + + +
[hide private]
[frames] | no frames]
+
+

Module Hierarchy

+
    +
  • example: This is the docstring for the example.py module.
    • +
+ + + + + + + + + + + + + + + + + +
   Home      Trees      Indices      Help   
+ + + + + +
+ Generated by Epydoc 3.0beta1 on Sun Sep 23 07:36:32 2007 + + http://epydoc.sourceforge.net +
+ + + + + diff --git a/numpy/doc/html/redirect.html b/numpy/doc/html/redirect.html new file mode 100644 index 000000000..dbd50828c --- /dev/null +++ b/numpy/doc/html/redirect.html @@ -0,0 +1,38 @@ +Epydoc Redirect Page + + + + + + + + +

Epydoc Auto-redirect page

+ +

When javascript is enabled, this page will redirect URLs of +the form redirect.html#dotted.name to the +documentation for the object with the given fully-qualified +dotted name.

+

 

+ + + + + diff --git a/numpy/doc/html/toc-everything.html b/numpy/doc/html/toc-everything.html new file mode 100644 index 000000000..f6ed84f8e --- /dev/null +++ b/numpy/doc/html/toc-everything.html @@ -0,0 +1,34 @@ + + + + + Everything + + + + + +

Everything

+
+

All Functions

+ example.foo
example.newfunc
example.otherfunc
+[hide private] + + + + + diff --git a/numpy/doc/html/toc-example-module.html b/numpy/doc/html/toc-example-module.html new file mode 100644 index 000000000..137dea5ae --- /dev/null +++ b/numpy/doc/html/toc-example-module.html @@ -0,0 +1,34 @@ + + + + + example + + + + + +

Module example

+
+

Functions

+ foo
newfunc
otherfunc
+[hide private] + + + + + diff --git a/numpy/doc/html/toc.html b/numpy/doc/html/toc.html new file mode 100644 index 000000000..d9863817f --- /dev/null +++ b/numpy/doc/html/toc.html @@ -0,0 +1,34 @@ + + + + + Table of Contents + + + + + +

Table of Contents

+
+ Everything +
+

Modules

+ example
+ [hide private] + + + + + -- cgit v1.2.1