[h5py] 226/455: Docs update

Ghislain Vaillant ghisvail-guest at moszumanska.debian.org
Thu Jul 2 18:19:36 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 24c4eb2657e3fb65cd145f37d7057dca8c5e67ef
Author: andrewcollette <andrew.collette at gmail.com>
Date:   Fri Feb 13 20:22:49 2009 +0000

    Docs update
---
 docs/source/conf.py         |  6 +++---
 docs/source/guide/build.rst | 15 ++++++++++-----
 2 files changed, 13 insertions(+), 8 deletions(-)

diff --git a/docs/source/conf.py b/docs/source/conf.py
index e2bbc0b..6541dea 100644
--- a/docs/source/conf.py
+++ b/docs/source/conf.py
@@ -46,9 +46,9 @@ copyright = '2008, Andrew Collette'
 # other places throughout the built documents.
 #
 # The short X.Y version.
-version = '1.0'
+version = '1.1'
 # The full version, including alpha/beta/rc tags.
-release = '1.0.0'
+release = '1.1.0'
 
 # There are two options for replacing |today|: either, you set today to some
 # non-false value, then it is used:
@@ -91,7 +91,7 @@ html_style = 'h5py.css'
 
 # The name for this set of Sphinx documents.  If None, it defaults to
 # "<project> v<release> documentation".
-html_title = "HDF5 for Python 1.0"
+html_title = "HDF5 for Python 1.1"
 
 # A shorter title for the navigation bar.  Default is the same as html_title.
 #html_short_title = None
diff --git a/docs/source/guide/build.rst b/docs/source/guide/build.rst
index 6e557e1..67386e0 100644
--- a/docs/source/guide/build.rst
+++ b/docs/source/guide/build.rst
@@ -69,11 +69,13 @@ Requires
 Quick installation
 ------------------
 
-H5py can now be automatically installed by setuptools' easy_install command::
+H5py can now be automatically installed by setuptools' easy_install command.
+You don't need to download anything; just run the command::
 
     $ [sudo] easy_install h5py
 
-Alternatively, you can install in the traditional manner by running setup.py::
+Alternatively, you can install in the traditional manner by downloading the
+most recent tarball of h5py, uncompressing it, and running setup.py::
 
     $ python setup.py build
     $ [sudo] python setup.py install
@@ -83,14 +85,17 @@ Custom installation
 -------------------
 
 Sometimes h5py may not be able to determine what version of HDF5 is installed.
-Also, sometimes HDF5 may be installed in an unusual location.  You can
-specify both your version of HDF5 and its location through the ``configure``
-command::
+Also, sometimes HDF5 may be installed in an unusual location.  When using
+setup.py directly, you can specify both your version of HDF5 and its location
+through the ``configure`` command::
 
     $ python setup.py configure [--hdf5=/path/to/hdf5] [--api=<16 or 18>]
     $ python setup.py build
     $ [sudo] python setup.py install
 
+The HDF5 directory you specify should contain sub-directories like "include",
+"lib" and "bin".
+
 Alternatively (for example, if installing with easy_install), you can use
 environment variables::
 

-- 
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