Skip to content

Commit

Permalink
Updated doc release: dev
Browse files Browse the repository at this point in the history
  • Loading branch information
markflorisson committed Apr 3, 2013
1 parent b03c276 commit 3086834
Show file tree
Hide file tree
Showing 44 changed files with 248 additions and 202 deletions.
2 changes: 1 addition & 1 deletion dev/.buildinfo
@@ -1,4 +1,4 @@
# Sphinx build info version 1
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
config: bd97d297720d5f98c2872cd089c4cd71
config: 436c99319d897513a51f7107c1a0c5a5
tags: fbb0d17656682115ca4d033fb2f83ba1
17 changes: 17 additions & 0 deletions dev/_sources/doc/roadmap.txt
Expand Up @@ -49,6 +49,23 @@ E.g.::
intrin = numba.declare_intrinsic(int64(), "llvm.readcyclecounter")
print intrin()

Source Annotator
----------------
Analogous to ``cython --annotate``, a tool that annotates numba source code
and finds and highlights which parts contain object calls. Ideally, this would
also include, for each source line (expand on click?):

* The final (unoptimized) LLVM bitcode

- And optionally the optimized code and/or assembly

* Code from intermediate numba representations

- After we start implementing several layers of IR,
see http://numba.pydata.org/numba-doc/dev/doc/ir.html

* The type of each sub-expression and variable (on hover?)

Numba Loader
------------
Allow two forms of code caching:
Expand Down
10 changes: 5 additions & 5 deletions dev/doc/architecture.html
Expand Up @@ -8,7 +8,7 @@
<head>
<meta charset="utf-8" />

<title>Numba Architecture &mdash; numba 0.7.2-278-ga8a2104 documentation</title>
<title>Numba Architecture &mdash; numba 0.7.2-278-ga8a2104-dirty documentation</title>

<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="description" content="">
Expand All @@ -35,7 +35,7 @@
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '../',
VERSION: '0.7.2-278-ga8a2104',
VERSION: '0.7.2-278-ga8a2104-dirty',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
Expand All @@ -59,7 +59,7 @@
});
});
</script>
<link rel="top" title="numba 0.7.2-278-ga8a2104 documentation" href="../index.html" />
<link rel="top" title="numba 0.7.2-278-ga8a2104-dirty documentation" href="../index.html" />
<link rel="next" title="Numba IR Stages" href="ir.html" />
<link rel="prev" title="Release Notes" href="releases.html" />
</head>
Expand All @@ -72,7 +72,7 @@
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</a>
<a class="brand" href="../index.html">numba 0.7.2-278-ga8a2104 documentation</a>
<a class="brand" href="../index.html">numba 0.7.2-278-ga8a2104-dirty documentation</a>
<div class="nav-collapse collapse">
<ul class="nav pull-right">

Expand Down Expand Up @@ -442,7 +442,7 @@ <h2><a class="toc-backref" href="#id15">Appendix</a><a class="headerlink" href="
<li><a href="../py-modindex.html" title="Python Module Index" >modules</a></li>
<li><a href="ir.html" title="Numba IR Stages" >next</a></li>
<li><a href="releases.html" title="Release Notes" >previous</a></li>
<li><a href="../index.html">numba 0.7.2-278-ga8a2104 documentation</a></li>
<li><a href="../index.html">numba 0.7.2-278-ga8a2104-dirty documentation</a></li>

</ul>
</div>
Expand Down
10 changes: 5 additions & 5 deletions dev/doc/arrays.html
Expand Up @@ -8,7 +8,7 @@
<head>
<meta charset="utf-8" />

<title>Arrays &mdash; numba 0.7.2-278-ga8a2104 documentation</title>
<title>Arrays &mdash; numba 0.7.2-278-ga8a2104-dirty documentation</title>

<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="description" content="">
Expand All @@ -35,7 +35,7 @@
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '../',
VERSION: '0.7.2-278-ga8a2104',
VERSION: '0.7.2-278-ga8a2104-dirty',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
Expand All @@ -59,7 +59,7 @@
});
});
</script>
<link rel="top" title="numba 0.7.2-278-ga8a2104 documentation" href="../index.html" />
<link rel="top" title="numba 0.7.2-278-ga8a2104-dirty documentation" href="../index.html" />
<link rel="next" title="Interfacing with C" href="interface_c.html" />
<link rel="prev" title="Python Functionality" href="pythonstuff.html" />
</head>
Expand All @@ -72,7 +72,7 @@
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</a>
<a class="brand" href="../index.html">numba 0.7.2-278-ga8a2104 documentation</a>
<a class="brand" href="../index.html">numba 0.7.2-278-ga8a2104-dirty documentation</a>
<div class="nav-collapse collapse">
<ul class="nav pull-right">

Expand Down Expand Up @@ -446,7 +446,7 @@ <h3>Building ufuncs using &#64;vectorize<a class="headerlink" href="#building-uf
<li><a href="../py-modindex.html" title="Python Module Index" >modules</a></li>
<li><a href="interface_c.html" title="Interfacing with C" >next</a></li>
<li><a href="pythonstuff.html" title="Python Functionality" >previous</a></li>
<li><a href="../index.html">numba 0.7.2-278-ga8a2104 documentation</a></li>
<li><a href="../index.html">numba 0.7.2-278-ga8a2104-dirty documentation</a></li>

</ul>
</div>
Expand Down
10 changes: 5 additions & 5 deletions dev/doc/doctest.html
Expand Up @@ -8,7 +8,7 @@
<head>
<meta charset="utf-8" />

<title>Using doctest with Numba &mdash; numba 0.7.2-278-ga8a2104 documentation</title>
<title>Using doctest with Numba &mdash; numba 0.7.2-278-ga8a2104-dirty documentation</title>

<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="description" content="">
Expand All @@ -35,7 +35,7 @@
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '../',
VERSION: '0.7.2-278-ga8a2104',
VERSION: '0.7.2-278-ga8a2104-dirty',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
Expand All @@ -59,7 +59,7 @@
});
});
</script>
<link rel="top" title="numba 0.7.2-278-ga8a2104 documentation" href="../index.html" />
<link rel="top" title="numba 0.7.2-278-ga8a2104-dirty documentation" href="../index.html" />
<link rel="next" title="Examples" href="examples.html" />
<link rel="prev" title="Adding Type Inference for External Code" href="type_inference.html" />
</head>
Expand All @@ -72,7 +72,7 @@
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</a>
<a class="brand" href="../index.html">numba 0.7.2-278-ga8a2104 documentation</a>
<a class="brand" href="../index.html">numba 0.7.2-278-ga8a2104-dirty documentation</a>
<div class="nav-collapse collapse">
<ul class="nav pull-right">

Expand Down Expand Up @@ -216,7 +216,7 @@ <h3>Quick search</h3>
<li><a href="../py-modindex.html" title="Python Module Index" >modules</a></li>
<li><a href="examples.html" title="Examples" >next</a></li>
<li><a href="type_inference.html" title="Adding Type Inference for External Code" >previous</a></li>
<li><a href="../index.html">numba 0.7.2-278-ga8a2104 documentation</a></li>
<li><a href="../index.html">numba 0.7.2-278-ga8a2104-dirty documentation</a></li>

</ul>
</div>
Expand Down
10 changes: 5 additions & 5 deletions dev/doc/examples.html
Expand Up @@ -8,7 +8,7 @@
<head>
<meta charset="utf-8" />

<title>Examples &mdash; numba 0.7.2-278-ga8a2104 documentation</title>
<title>Examples &mdash; numba 0.7.2-278-ga8a2104-dirty documentation</title>

<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="description" content="">
Expand All @@ -35,7 +35,7 @@
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '../',
VERSION: '0.7.2-278-ga8a2104',
VERSION: '0.7.2-278-ga8a2104-dirty',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
Expand All @@ -59,7 +59,7 @@
});
});
</script>
<link rel="top" title="numba 0.7.2-278-ga8a2104 documentation" href="../index.html" />
<link rel="top" title="numba 0.7.2-278-ga8a2104-dirty documentation" href="../index.html" />
<link rel="next" title="Release Notes" href="releases.html" />
<link rel="prev" title="Using doctest with Numba" href="doctest.html" />
</head>
Expand All @@ -72,7 +72,7 @@
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</a>
<a class="brand" href="../index.html">numba 0.7.2-278-ga8a2104 documentation</a>
<a class="brand" href="../index.html">numba 0.7.2-278-ga8a2104-dirty documentation</a>
<div class="nav-collapse collapse">
<ul class="nav pull-right">

Expand Down Expand Up @@ -563,7 +563,7 @@ <h2>Filterbank Correlation<a class="headerlink" href="#filterbank-correlation" t
<li><a href="../py-modindex.html" title="Python Module Index" >modules</a></li>
<li><a href="releases.html" title="Release Notes" >next</a></li>
<li><a href="doctest.html" title="Using doctest with Numba" >previous</a></li>
<li><a href="../index.html">numba 0.7.2-278-ga8a2104 documentation</a></li>
<li><a href="../index.html">numba 0.7.2-278-ga8a2104-dirty documentation</a></li>

</ul>
</div>
Expand Down
10 changes: 5 additions & 5 deletions dev/doc/interface_c.html
Expand Up @@ -8,7 +8,7 @@
<head>
<meta charset="utf-8" />

<title>Interfacing with C &mdash; numba 0.7.2-278-ga8a2104 documentation</title>
<title>Interfacing with C &mdash; numba 0.7.2-278-ga8a2104-dirty documentation</title>

<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="description" content="">
Expand All @@ -35,7 +35,7 @@
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '../',
VERSION: '0.7.2-278-ga8a2104',
VERSION: '0.7.2-278-ga8a2104-dirty',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
Expand All @@ -59,7 +59,7 @@
});
});
</script>
<link rel="top" title="numba 0.7.2-278-ga8a2104 documentation" href="../index.html" />
<link rel="top" title="numba 0.7.2-278-ga8a2104-dirty documentation" href="../index.html" />
<link rel="next" title="Static Compilation (pycc)" href="pycc.html" />
<link rel="prev" title="Arrays" href="arrays.html" />
</head>
Expand All @@ -72,7 +72,7 @@
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</a>
<a class="brand" href="../index.html">numba 0.7.2-278-ga8a2104 documentation</a>
<a class="brand" href="../index.html">numba 0.7.2-278-ga8a2104-dirty documentation</a>
<div class="nav-collapse collapse">
<ul class="nav pull-right">

Expand Down Expand Up @@ -467,7 +467,7 @@ <h2>References<a class="headerlink" href="#references" title="Permalink to this
<li><a href="../py-modindex.html" title="Python Module Index" >modules</a></li>
<li><a href="pycc.html" title="Static Compilation (pycc)" >next</a></li>
<li><a href="arrays.html" title="Arrays" >previous</a></li>
<li><a href="../index.html">numba 0.7.2-278-ga8a2104 documentation</a></li>
<li><a href="../index.html">numba 0.7.2-278-ga8a2104-dirty documentation</a></li>

</ul>
</div>
Expand Down
10 changes: 5 additions & 5 deletions dev/doc/ir.html
Expand Up @@ -8,7 +8,7 @@
<head>
<meta charset="utf-8" />

<title>Numba IR Stages &mdash; numba 0.7.2-278-ga8a2104 documentation</title>
<title>Numba IR Stages &mdash; numba 0.7.2-278-ga8a2104-dirty documentation</title>

<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="description" content="">
Expand All @@ -35,7 +35,7 @@
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '../',
VERSION: '0.7.2-278-ga8a2104',
VERSION: '0.7.2-278-ga8a2104-dirty',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
Expand All @@ -59,7 +59,7 @@
});
});
</script>
<link rel="top" title="numba 0.7.2-278-ga8a2104 documentation" href="../index.html" />
<link rel="top" title="numba 0.7.2-278-ga8a2104-dirty documentation" href="../index.html" />
<link rel="next" title="Numba Roadmap" href="roadmap.html" />
<link rel="prev" title="Numba Architecture" href="architecture.html" />
</head>
Expand All @@ -72,7 +72,7 @@
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</a>
<a class="brand" href="../index.html">numba 0.7.2-278-ga8a2104 documentation</a>
<a class="brand" href="../index.html">numba 0.7.2-278-ga8a2104-dirty documentation</a>
<div class="nav-collapse collapse">
<ul class="nav pull-right">

Expand Down Expand Up @@ -1076,7 +1076,7 @@ <h2>References<a class="headerlink" href="#references" title="Permalink to this
<li><a href="../py-modindex.html" title="Python Module Index" >modules</a></li>
<li><a href="roadmap.html" title="Numba Roadmap" >next</a></li>
<li><a href="architecture.html" title="Numba Architecture" >previous</a></li>
<li><a href="../index.html">numba 0.7.2-278-ga8a2104 documentation</a></li>
<li><a href="../index.html">numba 0.7.2-278-ga8a2104-dirty documentation</a></li>

</ul>
</div>
Expand Down
10 changes: 5 additions & 5 deletions dev/doc/modules/ast_constant_folding.html
Expand Up @@ -8,7 +8,7 @@
<head>
<meta charset="utf-8" />

<title>numba.ast_constant_folding &mdash; numba 0.7.2-278-ga8a2104 documentation</title>
<title>numba.ast_constant_folding &mdash; numba 0.7.2-278-ga8a2104-dirty documentation</title>

<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="description" content="">
Expand All @@ -35,7 +35,7 @@
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '../../',
VERSION: '0.7.2-278-ga8a2104',
VERSION: '0.7.2-278-ga8a2104-dirty',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
Expand All @@ -59,7 +59,7 @@
});
});
</script>
<link rel="top" title="numba 0.7.2-278-ga8a2104 documentation" href="../../index.html" />
<link rel="top" title="numba 0.7.2-278-ga8a2104-dirty documentation" href="../../index.html" />
<link rel="up" title="Numba Module Reference" href="../reference.html" />
<link rel="next" title="numba.ast_translate" href="ast_translate.html" />
<link rel="prev" title="numba" href="numba.html" />
Expand All @@ -73,7 +73,7 @@
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</a>
<a class="brand" href="../../index.html">numba 0.7.2-278-ga8a2104 documentation</a>
<a class="brand" href="../../index.html">numba 0.7.2-278-ga8a2104-dirty documentation</a>
<div class="nav-collapse collapse">
<ul class="nav pull-right">

Expand Down Expand Up @@ -259,7 +259,7 @@ <h3>Quick search</h3>
<li><a href="../../py-modindex.html" title="Python Module Index" >modules</a></li>
<li><a href="ast_translate.html" title="numba.ast_translate" >next</a></li>
<li><a href="numba.html" title="numba" >previous</a></li>
<li><a href="../../index.html">numba 0.7.2-278-ga8a2104 documentation</a></li>
<li><a href="../../index.html">numba 0.7.2-278-ga8a2104-dirty documentation</a></li>
<li><a href="../reference.html" >Numba Module Reference</a></li>

</ul>
Expand Down
10 changes: 5 additions & 5 deletions dev/doc/modules/ast_translate.html
Expand Up @@ -8,7 +8,7 @@
<head>
<meta charset="utf-8" />

<title>numba.ast_translate &mdash; numba 0.7.2-278-ga8a2104 documentation</title>
<title>numba.ast_translate &mdash; numba 0.7.2-278-ga8a2104-dirty documentation</title>

<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="description" content="">
Expand All @@ -35,7 +35,7 @@
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '../../',
VERSION: '0.7.2-278-ga8a2104',
VERSION: '0.7.2-278-ga8a2104-dirty',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
Expand All @@ -59,7 +59,7 @@
});
});
</script>
<link rel="top" title="numba 0.7.2-278-ga8a2104 documentation" href="../../index.html" />
<link rel="top" title="numba 0.7.2-278-ga8a2104-dirty documentation" href="../../index.html" />
<link rel="up" title="Numba Module Reference" href="../reference.html" />
<link rel="next" title="numba.ast_type_inference" href="ast_type_inference.html" />
<link rel="prev" title="numba.ast_constant_folding" href="ast_constant_folding.html" />
Expand All @@ -73,7 +73,7 @@
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</a>
<a class="brand" href="../../index.html">numba 0.7.2-278-ga8a2104 documentation</a>
<a class="brand" href="../../index.html">numba 0.7.2-278-ga8a2104-dirty documentation</a>
<div class="nav-collapse collapse">
<ul class="nav pull-right">

Expand Down Expand Up @@ -204,7 +204,7 @@ <h1>numba.ast_translate<a class="headerlink" href="#numba-ast-translate" title="
<li><a href="../../py-modindex.html" title="Python Module Index" >modules</a></li>
<li><a href="ast_type_inference.html" title="numba.ast_type_inference" >next</a></li>
<li><a href="ast_constant_folding.html" title="numba.ast_constant_folding" >previous</a></li>
<li><a href="../../index.html">numba 0.7.2-278-ga8a2104 documentation</a></li>
<li><a href="../../index.html">numba 0.7.2-278-ga8a2104-dirty documentation</a></li>
<li><a href="../reference.html" >Numba Module Reference</a></li>

</ul>
Expand Down

0 comments on commit 3086834

Please sign in to comment.