[h5py] 152/455: Unify docs structure
Ghislain Vaillant
ghisvail-guest at moszumanska.debian.org
Thu Jul 2 18:19:27 UTC 2015
This is an automated email from the git hooks/post-receive script.
ghisvail-guest pushed a commit to annotated tag 1.3.0
in repository h5py.
commit 62efd0f990e991b1982ed55844e820ae907a8045
Author: andrewcollette <andrew.collette at gmail.com>
Date: Mon Nov 10 03:07:25 2008 +0000
Unify docs structure
---
docs/API.html | 9 -
docs/Docs.html | 9 +
docs/Manual.html | 9 -
docs/source/_static/h5py.css | 536 ++++++++++++++++++++++
docs/source/_templates/layout.html | 20 +
{docs_api/source => docs/source/api}/index.rst | 0
{docs_api/source => docs/source/api}/low/h5.rst | 0
{docs_api/source => docs/source/api}/low/h5a.rst | 0
{docs_api/source => docs/source/api}/low/h5d.rst | 0
{docs_api/source => docs/source/api}/low/h5f.rst | 0
{docs_api/source => docs/source/api}/low/h5fd.rst | 0
{docs_api/source => docs/source/api}/low/h5g.rst | 0
{docs_api/source => docs/source/api}/low/h5i.rst | 0
{docs_api/source => docs/source/api}/low/h5l.rst | 0
{docs_api/source => docs/source/api}/low/h5o.rst | 0
{docs_api/source => docs/source/api}/low/h5p.rst | 0
{docs_api/source => docs/source/api}/low/h5r.rst | 0
{docs_api/source => docs/source/api}/low/h5s.rst | 0
{docs_api/source => docs/source/api}/low/h5t.rst | 0
{docs_api/source => docs/source/api}/low/h5z.rst | 0
{docs_api => docs}/source/automod.py | 0
docs/source/conf.py | 18 +-
docs/source/{ => guide}/build.rst | 0
docs/source/{ => guide}/datasets.rst | 0
docs/source/guide/hl.rst | 223 +++++++++
docs/source/{ => guide}/index.rst | 0
docs/source/{ => guide}/licenses.rst | 0
docs/source/{ => guide}/quick.rst | 0
docs/source/{ => guide}/threads.rst | 0
docs_api/Makefile | 70 ---
docs_api/source/conf.py | 188 --------
h5py/h5s.pyx | 2 +
setup.py | 16 +-
33 files changed, 806 insertions(+), 294 deletions(-)
diff --git a/docs/API.html b/docs/API.html
deleted file mode 100644
index 8171c2f..0000000
--- a/docs/API.html
+++ /dev/null
@@ -1,9 +0,0 @@
-<html>
-<!-- Redirect so the user doesn't have to manually find index.html -->
-<head>
-<title>h5py API Documentation</title>
-<meta http-equiv="REFRESH" content="0; url=api-html/index.html"></HEAD>
-<body>
-Redirecting to <a href="api-html/index.html">API docs index</a> in HTML folder...
-</body>
-</html>
diff --git a/docs/Docs.html b/docs/Docs.html
new file mode 100644
index 0000000..3651b77
--- /dev/null
+++ b/docs/Docs.html
@@ -0,0 +1,9 @@
+<html>
+<!-- Redirect so the user doesn't have to manually find index.html -->
+<head>
+<title>h5py Documentation</title>
+<meta http-equiv="REFRESH" content="0; url=html/index.html"></HEAD>
+<body>
+Redirecting to <a href="html/index.html">index</a> in HTML folder...
+</body>
+</html>
diff --git a/docs/Manual.html b/docs/Manual.html
deleted file mode 100644
index 5aa52f7..0000000
--- a/docs/Manual.html
+++ /dev/null
@@ -1,9 +0,0 @@
-<html>
-<!-- Redirect so the user doesn't have to manually find index.html -->
-<head>
-<title>h5py Documentation</title>
-<meta http-equiv="REFRESH" content="0; url=manual-html/index.html"></HEAD>
-<body>
-Redirecting to <a href="manual-html/index.html">index</a> in HTML folder...
-</body>
-</html>
diff --git a/docs/source/_static/h5py.css b/docs/source/_static/h5py.css
new file mode 100644
index 0000000..c2907f5
--- /dev/null
+++ b/docs/source/_static/h5py.css
@@ -0,0 +1,536 @@
+/**
+ * Alternate Sphinx design
+ * Originally created by Armin Ronacher for Werkzeug, adapted by Georg Brandl.
+ */
+
+body {
+ font-family: 'Lucida Grande', 'Lucida Sans Unicode', 'Geneva', 'Verdana', sans-serif;
+ font-size: 14px;
+ letter-spacing: -0.01em;
+ line-height: 150%;
+ text-align: center;
+ /*background-color: #AFC1C4; */
+ background-color: #BFD1D4;
+ color: black;
+ padding: 0;
+ border: 1px solid #aaa;
+ margin: 10px 80px 0px 80px;
+ min-width: 740px;
+}
+
+a {
+ color: #CA7900;
+ text-decoration: none;
+}
+
+a:hover {
+ color: #2491CF;
+}
+
+#tophdr {
+ background: #fff;
+ height: 3.0em;
+ list-style: none;
+ border-top: 1px solid #ddd;
+ border-bottom: 1px solid #ddd;
+ margin: 0;
+ padding-left: 10px;
+ padding-top: 10px;
+}
+
+#tophdr p {
+ font-size: 1.5em;
+ font-weight: 200;
+ padding: 0.25em;
+ margin: 0;
+ float: left;
+}
+
+#tophdr p.right {
+ float: right;
+ padding-right: 1.0em;
+}
+
+#tophdr p a {
+ color: #222;
+}
+
+#tophdr p a:hover {
+ color: #444;
+}
+
+pre {
+ font-family: 'Consolas', 'Deja Vu Sans Mono', 'Bitstream Vera Sans Mono', monospace;
+ font-size: 0.95em;
+ letter-spacing: 0.015em;
+ padding: 0.5em;
+ border: 1px solid #ccc;
+ background-color: #f8f8f8;
+}
+
+td.linenos pre {
+ padding: 0.5em 0;
+ border: 0;
+ background-color: transparent;
+ color: #aaa;
+}
+
+table.highlighttable {
+ margin-left: 0.5em;
+}
+
+table.highlighttable td {
+ padding: 0 0.5em 0 0.5em;
+}
+
+cite, code, tt {
+ font-family: 'Consolas', 'Deja Vu Sans Mono', 'Bitstream Vera Sans Mono', monospace;
+ font-size: 0.95em;
+ letter-spacing: 0.01em;
+}
+
+hr {
+ border: 1px solid #abc;
+ margin: 2em;
+}
+
+tt {
+ background-color: #f2f2f2;
+ border-bottom: 1px solid #ddd;
+ color: #333;
+}
+
+tt.descname {
+ background-color: transparent;
+ font-weight: bold;
+ font-size: 1.2em;
+ border: 0;
+}
+
+tt.descclassname {
+ background-color: transparent;
+ border: 0;
+}
+
+tt.xref {
+ background-color: transparent;
+ font-weight: bold;
+ border: 0;
+}
+
+a tt {
+ background-color: transparent;
+ font-weight: bold;
+ border: 0;
+ color: #CA7900;
+}
+
+a tt:hover {
+ color: #2491CF;
+}
+
+.field-list ul {
+ margin: 0;
+ padding-left: 1em;
+}
+
+.field-list p {
+ margin: 0;
+}
+
+dl {
+ margin-bottom: 15px;
+}
+
+dd p {
+ margin-top: 0px;
+}
+
+dd ul, dd table {
+ margin-bottom: 10px;
+}
+
+dd {
+ margin-top: 3px;
+ margin-bottom: 10px;
+ margin-left: 30px;
+}
+
+.refcount {
+ color: #060;
+}
+
+dt:target,
+.highlight {
+ background-color: #fbe54e;
+}
+
+dl.glossary dt {
+ font-weight: bold;
+ font-size: 1.1em;
+}
+
+pre {
+ line-height: 120%;
+}
+
+pre a {
+ color: inherit;
+ text-decoration: underline;
+}
+
+.first {
+ margin-top: 0 !important;
+}
+
+div.document {
+ background-color: white;
+ text-align: left;
+ background-image: url(contents.png);
+ background-repeat: repeat-x;
+}
+
+/*
+div.documentwrapper {
+ width: 100%;
+}
+*/
+
+div.clearer {
+ clear: both;
+}
+
+div.related h3 {
+ display: none;
+}
+
+div.related ul {
+ background-image: url(navigation.png);
+ height: 2em;
+ list-style: none;
+ border-top: 1px solid #ddd;
+ border-bottom: 1px solid #ddd;
+ margin: 0;
+ padding-left: 10px;
+}
+
+div.related ul li {
+ margin: 0;
+ padding: 0;
+ height: 2em;
+ float: left;
+}
+
+div.related ul li.right {
+ float: right;
+ margin-right: 5px;
+}
+
+div.related ul li a {
+ margin: 0;
+ padding: 0 5px 0 5px;
+ line-height: 1.75em;
+ color: #EE9816;
+}
+
+div.related ul li a:hover {
+ color: #3CA8E7;
+}
+
+div.body {
+ margin: 0;
+ padding: 0.5em 20px 20px 20px;
+}
+
+div.bodywrapper {
+ margin: 0 240px 0 0;
+ border-right: 1px solid #ccc;
+}
+
+div.body a {
+ text-decoration: underline;
+}
+
+div.sphinxsidebar {
+ margin: 0;
+ padding: 0.5em 15px 15px 0;
+ width: 210px;
+ float: right;
+ text-align: left;
+/* margin-left: -100%; */
+}
+
+div.sphinxsidebar h4, div.sphinxsidebar h3 {
+ margin: 1em 0 0.5em 0;
+ font-size: 0.9em;
+ padding: 0.1em 0 0.1em 0.5em;
+ color: white;
+ border: 1px solid #86989B;
+ background-color: #AFC1C4;
+}
+
+div.sphinxsidebar ul {
+ padding-left: 1.5em;
+ margin-top: 4px;
+ margin-bottom: 7px;
+ list-style: none;
+ padding: 0;
+ line-height: 130%;
+}
+
+div.sphinxsidebar ul ul {
+ list-style: square;
+ margin-left: 20px;
+}
+
+p {
+ margin: 0.8em 0 0.5em 0;
+}
+
+p.rubric {
+ font-weight: bold;
+}
+
+h1 {
+ margin: 0;
+ padding: 0.7em 0 0.3em 0;
+ font-size: 1.5em;
+ color: #11557C;
+}
+
+h2 {
+ margin: 1.3em 0 0.2em 0;
+ font-size: 1.35em;
+ padding: 0;
+}
+
+h3 {
+ margin: 1em 0 -0.3em 0;
+ font-size: 1.2em;
+}
+
+h1 a, h2 a, h3 a, h4 a, h5 a, h6 a {
+ color: black!important;
+}
+
+h1 a.anchor, h2 a.anchor, h3 a.anchor, h4 a.anchor, h5 a.anchor, h6 a.anchor {
+ display: none;
+ margin: 0 0 0 0.3em;
+ padding: 0 0.2em 0 0.2em;
+ color: #aaa!important;
+}
+
+h1:hover a.anchor, h2:hover a.anchor, h3:hover a.anchor, h4:hover a.anchor,
+h5:hover a.anchor, h6:hover a.anchor {
+ display: inline;
+}
+
+h1 a.anchor:hover, h2 a.anchor:hover, h3 a.anchor:hover, h4 a.anchor:hover,
+h5 a.anchor:hover, h6 a.anchor:hover {
+ color: #777;
+ background-color: #eee;
+}
+
+table {
+ border-collapse: collapse;
+ margin: 0 -0.5em 0 -0.5em;
+}
+
+table td, table th {
+ padding: 0.2em 0.5em 0.2em 0.5em;
+}
+
+div.footer {
+ background-color: #E3EFF1;
+ color: #86989B;
+ padding: 3px 8px 3px 0;
+ clear: both;
+ font-size: 0.8em;
+ text-align: right;
+}
+
+div.footer a {
+ color: #86989B;
+ text-decoration: underline;
+}
+
+div.pagination {
+ margin-top: 2em;
+ padding-top: 0.5em;
+ border-top: 1px solid black;
+ text-align: center;
+}
+
+div.sphinxsidebar ul.toc {
+ margin: 1em 0 1em 0;
+ padding: 0 0 0 0.5em;
+ list-style: none;
+}
+
+div.sphinxsidebar ul.toc li {
+ margin: 0.5em 0 0.5em 0;
+ font-size: 0.9em;
+ line-height: 130%;
+}
+
+div.sphinxsidebar ul.toc li p {
+ margin: 0;
+ padding: 0;
+}
+
+div.sphinxsidebar ul.toc ul {
+ margin: 0.2em 0 0.2em 0;
+ padding: 0 0 0 1.8em;
+}
+
+div.sphinxsidebar ul.toc ul li {
+ padding: 0;
+}
+
+div.admonition, div.warning {
+ font-size: 0.9em;
+ margin: 1em 0 0 0;
+ border: 1px solid #86989B;
+ background-color: #f7f7f7;
+}
+
+div.admonition p, div.warning p {
+ margin: 0.5em 1em 0.5em 1em;
+ padding: 0;
+}
+
+div.admonition pre, div.warning pre {
+ margin: 0.4em 1em 0.4em 1em;
+}
+
+div.admonition p.admonition-title,
+div.warning p.admonition-title {
+ margin: 0;
+ padding: 0.1em 0 0.1em 0.5em;
+ color: white;
+ border-bottom: 1px solid #86989B;
+ font-weight: bold;
+ background-color: #AFC1C4;
+}
+
+div.warning {
+ border: 1px solid #940000;
+}
+
+div.warning p.admonition-title {
+ background-color: #CF0000;
+ border-bottom-color: #940000;
+}
+
+div.admonition ul, div.admonition ol,
+div.warning ul, div.warning ol {
+ margin: 0.1em 0.5em 0.5em 3em;
+ padding: 0;
+}
+
+div.versioninfo {
+ margin: 1em 0 0 0;
+ border: 1px solid #ccc;
+ background-color: #DDEAF0;
+ padding: 8px;
+ line-height: 1.3em;
+ font-size: 0.9em;
+}
+
+
+a.headerlink {
+ color: #c60f0f!important;
+ font-size: 1em;
+ margin-left: 6px;
+ padding: 0 4px 0 4px;
+ text-decoration: none!important;
+ visibility: hidden;
+}
+
+h1:hover > a.headerlink,
+h2:hover > a.headerlink,
+h3:hover > a.headerlink,
+h4:hover > a.headerlink,
+h5:hover > a.headerlink,
+h6:hover > a.headerlink,
+dt:hover > a.headerlink {
+ visibility: visible;
+}
+
+a.headerlink:hover {
+ background-color: #ccc;
+ color: white!important;
+}
+
+table.indextable td {
+ text-align: left;
+ vertical-align: top;
+}
+
+table.indextable dl, table.indextable dd {
+ margin-top: 0;
+ margin-bottom: 0;
+}
+
+table.indextable tr.pcap {
+ height: 10px;
+}
+
+table.indextable tr.cap {
+ margin-top: 10px;
+ background-color: #f2f2f2;
+}
+
+img.toggler {
+ margin-right: 3px;
+ margin-top: 3px;
+ cursor: pointer;
+}
+
+form.pfform {
+ margin: 10px 0 20px 0;
+}
+
+table.contentstable {
+ width: 90%;
+}
+
+table.contentstable p.biglink {
+ line-height: 150%;
+}
+
+a.biglink {
+ font-size: 1.3em;
+}
+
+span.linkdescr {
+ font-style: italic;
+ padding-top: 5px;
+ font-size: 90%;
+}
+
+ul.search {
+ margin: 10px 0 0 20px;
+ padding: 0;
+}
+
+ul.search li {
+ padding: 5px 0 5px 20px;
+ background-image: url(file.png);
+ background-repeat: no-repeat;
+ background-position: 0 7px;
+}
+
+ul.search li a {
+ font-weight: bold;
+}
+
+ul.search li div.context {
+ color: #888;
+ margin: 2px 0 0 30px;
+ text-align: left;
+}
+
+ul.keywordmatches li.goodmatch a {
+ font-weight: bold;
+}
diff --git a/docs/source/_templates/layout.html b/docs/source/_templates/layout.html
new file mode 100644
index 0000000..c0d015e
--- /dev/null
+++ b/docs/source/_templates/layout.html
@@ -0,0 +1,20 @@
+{% extends '!layout.html' %}
+
+
+{% block relbar1 %}
+<div id="tophdr">
+<p class="right"><a href="http://h5py.alfven.org">h5py.alfven.org</a></p>
+<p>HDF5 for Python Documentation</p>
+</div><div class="clearer"></div>
+{{ super() }}
+{% endblock %}
+
+{% block relbar2 %}{% endblock %}
+{% block sidebar1 %}{{ sidebar() }}{% endblock %}
+{% block sidebar2 %}{% endblock %}
+
+{% block footer %}
+{{ super() }}
+{# tracker goes here #}
+{% endblock %}
+
diff --git a/docs_api/source/index.rst b/docs/source/api/index.rst
similarity index 100%
rename from docs_api/source/index.rst
rename to docs/source/api/index.rst
diff --git a/docs_api/source/low/h5.rst b/docs/source/api/low/h5.rst
similarity index 100%
rename from docs_api/source/low/h5.rst
rename to docs/source/api/low/h5.rst
diff --git a/docs_api/source/low/h5a.rst b/docs/source/api/low/h5a.rst
similarity index 100%
rename from docs_api/source/low/h5a.rst
rename to docs/source/api/low/h5a.rst
diff --git a/docs_api/source/low/h5d.rst b/docs/source/api/low/h5d.rst
similarity index 100%
rename from docs_api/source/low/h5d.rst
rename to docs/source/api/low/h5d.rst
diff --git a/docs_api/source/low/h5f.rst b/docs/source/api/low/h5f.rst
similarity index 100%
rename from docs_api/source/low/h5f.rst
rename to docs/source/api/low/h5f.rst
diff --git a/docs_api/source/low/h5fd.rst b/docs/source/api/low/h5fd.rst
similarity index 100%
rename from docs_api/source/low/h5fd.rst
rename to docs/source/api/low/h5fd.rst
diff --git a/docs_api/source/low/h5g.rst b/docs/source/api/low/h5g.rst
similarity index 100%
rename from docs_api/source/low/h5g.rst
rename to docs/source/api/low/h5g.rst
diff --git a/docs_api/source/low/h5i.rst b/docs/source/api/low/h5i.rst
similarity index 100%
rename from docs_api/source/low/h5i.rst
rename to docs/source/api/low/h5i.rst
diff --git a/docs_api/source/low/h5l.rst b/docs/source/api/low/h5l.rst
similarity index 100%
rename from docs_api/source/low/h5l.rst
rename to docs/source/api/low/h5l.rst
diff --git a/docs_api/source/low/h5o.rst b/docs/source/api/low/h5o.rst
similarity index 100%
rename from docs_api/source/low/h5o.rst
rename to docs/source/api/low/h5o.rst
diff --git a/docs_api/source/low/h5p.rst b/docs/source/api/low/h5p.rst
similarity index 100%
rename from docs_api/source/low/h5p.rst
rename to docs/source/api/low/h5p.rst
diff --git a/docs_api/source/low/h5r.rst b/docs/source/api/low/h5r.rst
similarity index 100%
rename from docs_api/source/low/h5r.rst
rename to docs/source/api/low/h5r.rst
diff --git a/docs_api/source/low/h5s.rst b/docs/source/api/low/h5s.rst
similarity index 100%
rename from docs_api/source/low/h5s.rst
rename to docs/source/api/low/h5s.rst
diff --git a/docs_api/source/low/h5t.rst b/docs/source/api/low/h5t.rst
similarity index 100%
rename from docs_api/source/low/h5t.rst
rename to docs/source/api/low/h5t.rst
diff --git a/docs_api/source/low/h5z.rst b/docs/source/api/low/h5z.rst
similarity index 100%
rename from docs_api/source/low/h5z.rst
rename to docs/source/api/low/h5z.rst
diff --git a/docs_api/source/automod.py b/docs/source/automod.py
similarity index 100%
rename from docs_api/source/automod.py
rename to docs/source/automod.py
diff --git a/docs/source/conf.py b/docs/source/conf.py
index 503fa8b..dfe2134 100644
--- a/docs/source/conf.py
+++ b/docs/source/conf.py
@@ -12,6 +12,9 @@
# serve to show the default value.
import sys, os
+pth = os.getenv('H5PY_PATH', None)
+if pth is not None:
+ sys.path[:] = [pth]+sys.path
# If your extensions are in another directory, add it here. If the directory
# is relative to the documentation root, use os.path.abspath to make it
@@ -23,7 +26,8 @@ import sys, os
# Add any Sphinx extension module names here, as strings. They can be extensions
# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
-extensions = ['sphinx.ext.autodoc']
+sys.path += [os.path.abspath('.')]
+extensions = ['sphinx.ext.autodoc', 'automod']
# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']
@@ -35,16 +39,16 @@ source_suffix = '.rst'
master_doc = 'index'
# General substitutions.
-project = 'h5py'
+project = 'h5py Low-Level API'
copyright = '2008, Andrew Collette'
# The default replacements for |version| and |release|, also used in various
# other places throughout the built documents.
#
# The short X.Y version.
-version = '0.3'
+version = '0.4'
# The full version, including alpha/beta/rc tags.
-release = '0.3.1'
+release = '0.4.0'
# There are two options for replacing |today|: either, you set today to some
# non-false value, then it is used:
@@ -83,7 +87,7 @@ pygments_style = 'sphinx'
# The style sheet to use for HTML and HTML Help pages. A file of that name
# must exist either in Sphinx' static/ path, or in one of the custom paths
# given in html_static_path.
-html_style = 'default.css'
+html_style = 'h5py.css'
# The name for this set of Sphinx documents. If None, it defaults to
# "<project> v<release> documentation".
@@ -108,11 +112,11 @@ html_static_path = ['_static']
# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
# using the given strftime format.
-html_last_updated_fmt = '%b %d, %Y'
+html_last_updated_fmt = '' #'%b %d, %Y'
# If true, SmartyPants will be used to convert quotes and dashes to
# typographically correct entities.
-#html_use_smartypants = True
+html_use_smartypants = False
# Custom sidebar templates, maps document names to template names.
#html_sidebars = {}
diff --git a/docs/source/build.rst b/docs/source/guide/build.rst
similarity index 100%
rename from docs/source/build.rst
rename to docs/source/guide/build.rst
diff --git a/docs/source/datasets.rst b/docs/source/guide/datasets.rst
similarity index 100%
rename from docs/source/datasets.rst
rename to docs/source/guide/datasets.rst
diff --git a/docs/source/guide/hl.rst b/docs/source/guide/hl.rst
new file mode 100644
index 0000000..f60c832
--- /dev/null
+++ b/docs/source/guide/hl.rst
@@ -0,0 +1,223 @@
+
+*********
+Reference
+*********
+
+.. module:: h5py.highlevel
+
+Groups
+======
+
+.. class:: Group
+
+ .. method:: __getitem__(name)
+
+ Open an object in this group.
+
+ .. method:: __setitem__(name, object)
+
+ Add the given object to the group.
+
+ The action taken depends on the type of object assigned:
+
+ Named HDF5 object (Dataset, Group, Datatype)
+ A hard link is created in this group which points to the
+ given object.
+
+ Numpy ndarray
+ The array is converted to a dataset object, with default
+ settings (contiguous storage, etc.). See :meth:`create_dataset`
+ for a more flexible way to do this.
+
+ Numpy dtype
+ Commit a copy of the datatype as a named datatype in the file.
+
+ Anything else
+ Attempt to convert it to an ndarray and store it. Scalar
+ values are stored as scalar datasets. Raise ValueError if we
+ can't understand the resulting array dtype.
+
+ If a group member of the same name already exists, the assignment
+ will fail.
+
+ .. method:: __delitem__(name)
+
+ Remove (unlink) this member.
+
+ .. method:: __len__
+
+ Number of group members
+
+ .. method:: __iter__
+
+ Yields the names of group members
+
+ .. method:: __contains__(name)
+
+ See if the given name is in this group.
+
+ .. method:: create_group(name) -> Group
+
+ Create a new HDF5 group.
+
+ Fails with H5Error if the group already exists.
+
+ .. method:: require_group(name) -> Group
+
+ Open the specified HDF5 group, creating it if it doesn't exist.
+
+ Fails with H5Error if an incompatible object (dataset or named type)
+ already exists.
+
+ .. method:: create_dataset(name, [shape, [dtype]], [data], **kwds) -> Dataset
+
+ Create a new dataset. There are two logical ways to specify the dataset:
+
+ 1. Give the shape, and optionally the dtype. If the dtype is not given,
+ single-precision floating point ('=f4') will be assumed.
+ 2. Give a NumPy array (or anything that can be converted to a NumPy array)
+ via the "data" argument. The shape and dtype of this array will be
+ used, and the dataset will be initialized to its contents.
+
+ Additional keyword parameters control the details of how the dataset is
+ stored.
+
+ **shape** (None or tuple)
+ NumPy-style shape tuple. Required if data is not given.
+
+ **dtype** (None or dtype)
+ NumPy dtype (or anything that can be converted). Optional;
+ the default is '=f4'. Will override the dtype of any data
+ array given via the *data* parameter.
+
+ **data** (None or ndarray)
+ Either a NumPy ndarray or anything that can be converted to one.
+
+ Keywords:
+
+ **chunks** (None or tuple)
+ Manually specify a chunked layout for the dataset. It's
+ recommended you let the library determine this value for you.
+
+ **compression** (None or int)
+ Enable DEFLATE (gzip) compression, at this integer value.
+
+ **shuffle** (True/False)
+ Enable the shuffle filter, which can provide higher compression ratios
+ when used with the compression filter.
+
+ **fletcher32** (True/False)
+ Enable error detection.
+
+ **maxshape** (None or tuple)
+ Make the dataset extendable, up to this maximum shape. Should be a
+ NumPy-style shape tuple. Dimensions with value None have no upper
+ limit.
+
+ .. method:: require_dataset(name, [shape, [dtype]], [data], **kwds) -> Dataset
+
+ Open a new dataset, creating one if it doesn't exist.
+
+ This method operates exactly like :meth:`create_dataset`, except that if
+ a dataset with compatible shape and dtype already exists, it is opened
+ instead. The additional keyword arguments are only honored when actually
+ creating a dataset; they are ignored for the comparison.
+
+ .. method:: copy(source, dest)
+
+ Recusively copy an object from one location to another, or between files.
+
+ Copies the given object, and (if it is a group) all objects below it in
+ the hierarchy. The destination need not be in the same file.
+
+ **source** (Group, Dataset, Datatype or str)
+ Source object or path.
+
+ **dest** (Group or str)
+ Destination. Must be either Group or path. If a Group object, it may
+ be in a different file.
+
+ .. method:: visit(func)
+
+ Recursively iterate a callable over objects in this group.
+
+ You supply a callable (function, method or callable object); it
+ will be called exactly once for each link in this group and every
+ group below it. Your callable must conform to the signature::
+
+ func(<member name>) => <None or return value>
+
+ Returning None continues iteration, returning anything else stops
+ and immediately returns that value from the visit method. No
+ particular order of iteration within groups is guranteed.
+
+ Example::
+
+ >>> # List the entire contents of the file
+ >>> f = File("foo.hdf5")
+ >>> list_of_names = []
+ >>> f.visit(list_of_names.append)
+
+ **Only available with HDF5 1.8.X.**
+
+ .. method:: visititems(func)
+
+ Recursively visit names and objects in this group and subgroups.
+
+ You supply a callable (function, method or callable object); it
+ will be called exactly once for each link in this group and every
+ group below it. Your callable must conform to the signature::
+
+ func(<member name>, <object>) => <None or return value>
+
+ Returning None continues iteration, returning anything else stops
+ and immediately returns that value from the visit method. No
+ particular order of iteration within groups is guranteed.
+
+ Example::
+
+ # Get a list of all datasets in the file
+ >>> mylist = []
+ >>> def func(name, obj):
+ ... if isinstance(obj, Dataset):
+ ... mylist.append(name)
+ ...
+ >>> f = File('foo.hdf5')
+ >>> f.visititems(func)
+
+ **Only available with HDF5 1.8.X.**
+
+ .. method:: listnames
+
+ Get a list of member names
+
+ .. method:: iternames
+
+ Get an iterator over member names. Equivalent to iter(group).
+
+ .. method:: listobjects
+
+ Get a list with all objects in this group.
+
+ .. method:: iterobjects
+
+ Get an iterator over objects in this group
+
+ .. method:: listitems
+
+ Get an list of (name, object) pairs for the members of this group.
+
+ .. method:: iteritems
+
+ Get an iterator over (name, object) pairs for the members of this group.
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/source/index.rst b/docs/source/guide/index.rst
similarity index 100%
rename from docs/source/index.rst
rename to docs/source/guide/index.rst
diff --git a/docs/source/licenses.rst b/docs/source/guide/licenses.rst
similarity index 100%
rename from docs/source/licenses.rst
rename to docs/source/guide/licenses.rst
diff --git a/docs/source/quick.rst b/docs/source/guide/quick.rst
similarity index 100%
rename from docs/source/quick.rst
rename to docs/source/guide/quick.rst
diff --git a/docs/source/threads.rst b/docs/source/guide/threads.rst
similarity index 100%
rename from docs/source/threads.rst
rename to docs/source/guide/threads.rst
diff --git a/docs_api/Makefile b/docs_api/Makefile
deleted file mode 100644
index 0b09677..0000000
--- a/docs_api/Makefile
+++ /dev/null
@@ -1,70 +0,0 @@
-# Makefile for Sphinx documentation
-#
-
-# You can set these variables from the command line.
-SPHINXOPTS =
-SPHINXBUILD = sphinx-build
-PAPER =
-
-# Internal variables.
-PAPEROPT_a4 = -D latex_paper_size=a4
-PAPEROPT_letter = -D latex_paper_size=letter
-ALLSPHINXOPTS = -d build/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source
-
-.PHONY: help clean html web pickle htmlhelp latex changes linkcheck
-
-help:
- @echo "Please use \`make <target>' where <target> is one of"
- @echo " html to make standalone HTML files"
- @echo " pickle to make pickle files (usable by e.g. sphinx-web)"
- @echo " htmlhelp to make HTML files and a HTML help project"
- @echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
- @echo " changes to make an overview over all changed/added/deprecated items"
- @echo " linkcheck to check all external links for integrity"
-
-clean:
- -rm -rf build/*
-
-html:
- mkdir -p build/html build/doctrees
- $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) build/html
- @echo
- @echo "Build finished. The HTML pages are in build/html."
-
-pickle:
- mkdir -p build/pickle build/doctrees
- $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) build/pickle
- @echo
- @echo "Build finished; now you can process the pickle files or run"
- @echo " sphinx-web build/pickle"
- @echo "to start the sphinx-web server."
-
-web: pickle
-
-htmlhelp:
- mkdir -p build/htmlhelp build/doctrees
- $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) build/htmlhelp
- @echo
- @echo "Build finished; now you can run HTML Help Workshop with the" \
- ".hhp project file in build/htmlhelp."
-
-latex:
- mkdir -p build/latex build/doctrees
- $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) build/latex
- @echo
- @echo "Build finished; the LaTeX files are in build/latex."
- @echo "Run \`make all-pdf' or \`make all-ps' in that directory to" \
- "run these through (pdf)latex."
-
-changes:
- mkdir -p build/changes build/doctrees
- $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) build/changes
- @echo
- @echo "The overview file is in build/changes."
-
-linkcheck:
- mkdir -p build/linkcheck build/doctrees
- $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) build/linkcheck
- @echo
- @echo "Link check complete; look for any errors in the above output " \
- "or in build/linkcheck/output.txt."
diff --git a/docs_api/source/conf.py b/docs_api/source/conf.py
deleted file mode 100644
index 376f9f7..0000000
--- a/docs_api/source/conf.py
+++ /dev/null
@@ -1,188 +0,0 @@
-# -*- coding: utf-8 -*-
-#
-# h5py documentation build configuration file, created by
-# sphinx-quickstart on Tue Aug 5 14:14:15 2008.
-#
-# This file is execfile()d with the current directory set to its containing dir.
-#
-# The contents of this file are pickled, so don't put values in the namespace
-# that aren't pickleable (module imports are okay, they're removed automatically).
-#
-# All configuration values have a default value; values that are commented out
-# serve to show the default value.
-
-import sys, os
-pth = os.getenv('H5PY_PATH', None)
-if pth is not None:
- sys.path[:] = [pth]+sys.path
-
-# If your extensions are in another directory, add it here. If the directory
-# is relative to the documentation root, use os.path.abspath to make it
-# absolute, like shown here.
-#sys.path.append(os.path.abspath('some/directory'))
-
-# General configuration
-# ---------------------
-
-# Add any Sphinx extension module names here, as strings. They can be extensions
-# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
-sys.path += [os.path.abspath('.')]
-extensions = ['sphinx.ext.autodoc', 'automod']
-
-# Add any paths that contain templates here, relative to this directory.
-templates_path = ['_templates']
-
-# The suffix of source filenames.
-source_suffix = '.rst'
-
-# The master toctree document.
-master_doc = 'index'
-
-# General substitutions.
-project = 'h5py Low-Level API'
-copyright = '2008, Andrew Collette'
-
-# The default replacements for |version| and |release|, also used in various
-# other places throughout the built documents.
-#
-# The short X.Y version.
-version = '0.4'
-# The full version, including alpha/beta/rc tags.
-release = '0.4.0'
-
-# There are two options for replacing |today|: either, you set today to some
-# non-false value, then it is used:
-#today = ''
-# Else, today_fmt is used as the format for a strftime call.
-today_fmt = '%B %d, %Y'
-
-# List of documents that shouldn't be included in the build.
-#unused_docs = []
-
-# List of directories, relative to source directories, that shouldn't be searched
-# for source files.
-#exclude_dirs = []
-
-# The reST default role (used for this markup: `text`) to use for all documents.
-#default_role = None
-
-# If true, '()' will be appended to :func: etc. cross-reference text.
-#add_function_parentheses = True
-
-# If true, the current module name will be prepended to all description
-# unit titles (such as .. function::).
-#add_module_names = True
-
-# If true, sectionauthor and moduleauthor directives will be shown in the
-# output. They are ignored by default.
-#show_authors = False
-
-# The name of the Pygments (syntax highlighting) style to use.
-pygments_style = 'sphinx'
-
-
-# Options for HTML output
-# -----------------------
-
-# The style sheet to use for HTML and HTML Help pages. A file of that name
-# must exist either in Sphinx' static/ path, or in one of the custom paths
-# given in html_static_path.
-html_style = 'default.css'
-
-# The name for this set of Sphinx documents. If None, it defaults to
-# "<project> v<release> documentation".
-#html_title = None
-
-# A shorter title for the navigation bar. Default is the same as html_title.
-#html_short_title = None
-
-# The name of an image file (within the static path) to place at the top of
-# the sidebar.
-#html_logo = None
-
-# The name of an image file (within the static path) to use as favicon of the
-# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
-# pixels large.
-#html_favicon = None
-
-# Add any paths that contain custom static files (such as style sheets) here,
-# relative to this directory. They are copied after the builtin static files,
-# so a file named "default.css" will overwrite the builtin "default.css".
-html_static_path = ['_static']
-
-# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
-# using the given strftime format.
-html_last_updated_fmt = '%b %d, %Y'
-
-# If true, SmartyPants will be used to convert quotes and dashes to
-# typographically correct entities.
-#html_use_smartypants = True
-
-# Custom sidebar templates, maps document names to template names.
-#html_sidebars = {}
-
-# Additional templates that should be rendered to pages, maps page names to
-# template names.
-#html_additional_pages = {}
-
-# If false, no module index is generated.
-html_use_modindex = False
-
-# If false, no index is generated.
-html_use_index = False
-
-# If true, the index is split into individual pages for each letter.
-#html_split_index = False
-
-# If true, the reST sources are included in the HTML build as _sources/<name>.
-#html_copy_source = True
-
-# If true, an OpenSearch description file will be output, and all pages will
-# contain a <link> tag referring to it. The value of this option must be the
-# base URL from which the finished HTML is served.
-#html_use_opensearch = ''
-
-# If nonempty, this is the file name suffix for HTML files (e.g. ".xhtml").
-#html_file_suffix = ''
-
-# Output file base name for HTML help builder.
-htmlhelp_basename = 'h5pydoc'
-
-
-# Options for LaTeX output
-# ------------------------
-
-# The paper size ('letter' or 'a4').
-#latex_paper_size = 'letter'
-
-# The font size ('10pt', '11pt' or '12pt').
-#latex_font_size = '10pt'
-
-# Grouping the document tree into LaTeX files. List of tuples
-# (source start file, target name, title, author, document class [howto/manual]).
-latex_documents = [
- ('index', 'h5py.tex', 'h5py Documentation',
- 'Andrew Collette', 'manual'),
-]
-
-# The name of an image file (relative to this directory) to place at the top of
-# the title page.
-#latex_logo = None
-
-# For "manual" documents, if this is true, then toplevel headings are parts,
-# not chapters.
-#latex_use_parts = False
-
-# Additional stuff for the LaTeX preamble.
-#latex_preamble = ''
-
-# Documents to append as an appendix to all manuals.
-#latex_appendices = []
-
-# If false, no module index is generated.
-#latex_use_modindex = True
-
-
-
-
-
diff --git a/h5py/h5s.pyx b/h5py/h5s.pyx
index 5417681..6cc7efe 100644
--- a/h5py/h5s.pyx
+++ b/h5py/h5s.pyx
@@ -132,6 +132,8 @@ cdef class SpaceID(ObjectID):
* Hashable: No
* Equality: Unimplemented
+
+ Can be pickled if HDF5 1.8 is available.
"""
property shape:
diff --git a/setup.py b/setup.py
index 5212d98..e524268 100644
--- a/setup.py
+++ b/setup.py
@@ -380,23 +380,17 @@ class doc(Command):
buildobj.run()
pth = op.abspath(buildobj.build_lib)
- for x in ('docs/manual-html', 'docs/api-html',
- 'docs/build', 'docs_api/build'):
+ for x in ('docs/html', 'docs/build'):
if op.exists(x):
shutil.rmtree(x)
- cmd1 = "cd docs; make html"
- cmd2 = "export H5PY_PATH=%s; cd docs_api; make html" % pth
+ cmd = "export H5PY_PATH=%s; cd docs; make html" % pth
- retval = os.system(cmd1)
+ retval = os.system(cmd)
if retval != 0:
- fatal("Can't build manual")
- retval = os.system(cmd2)
- if retval != 0:
- fatal("Can't build API documentation")
+ fatal("Can't build documentation")
- shutil.copytree('docs/build/html', 'docs/manual-html')
- shutil.copytree('docs_api/build/html', 'docs/api-html')
+ shutil.copytree('docs/build/html', 'docs/html')
class cyclean(Command):
--
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/debian-science/packages/h5py.git
More information about the debian-science-commits
mailing list