Commit 36ce30ac authored by Manuel Günther's avatar Manuel Günther
Browse files

New README and documentation strategy.

parent 07b2bdef
language: python
matrix:
include:
- python: 2.6
- python: 2.7
env:
- secure: NhXIeBJnBiEojHI9SgHEi6JsEPaMmzitJPnS71U0IdOoQKGPgnrTnTtQ1BGRRMzLcz7f2fv6EzUfzQh5AFj7SAHqhUhOIGYm9IsleQ+XPpddFvAf8q7AIEo3PxbykDrFTG/H9+25iv1rKHHipSkLvPQPTSN6Tk7wh8hGs6PZzK4=
- secure: J0zc2ogPlbqkSsDYaHVwCdQk+FbuU/j6+j45AiZYgGogDucJFsRtoIyJUF1KqT2vYWyRB1ffNL/TnHdMbxI16NvTDgMQea3TznUvOMwFvLAX4lfkcFxD99DicTYRFLw7SvOfmu+c6cG/o7y5V3nu4R3hZwe6K5rX95dfXIAuT/E=
- python: 3.2
env:
- NUMPYSPEC===1.7.1
- python: 3.3
env:
- NUMPYSPEC===1.8.0
- python: 2.6
- python: 2.7
env:
- secure: NhXIeBJnBiEojHI9SgHEi6JsEPaMmzitJPnS71U0IdOoQKGPgnrTnTtQ1BGRRMzLcz7f2fv6EzUfzQh5AFj7SAHqhUhOIGYm9IsleQ+XPpddFvAf8q7AIEo3PxbykDrFTG/H9+25iv1rKHHipSkLvPQPTSN6Tk7wh8hGs6PZzK4=
- secure: J0zc2ogPlbqkSsDYaHVwCdQk+FbuU/j6+j45AiZYgGogDucJFsRtoIyJUF1KqT2vYWyRB1ffNL/TnHdMbxI16NvTDgMQea3TznUvOMwFvLAX4lfkcFxD99DicTYRFLw7SvOfmu+c6cG/o7y5V3nu4R3hZwe6K5rX95dfXIAuT/E=
- BOB_DOCUMENTATION_SERVER=https://www.idiap.ch/software/bob/docs/latest/bioidiap/%s/master
- python: 3.2
env:
- NUMPYSPEC===1.7.1
- python: 3.3
env:
- NUMPYSPEC===1.8.0
before_install:
- sudo add-apt-repository -y ppa:biometrics/bob
- sudo apt-get update -qq
- sudo apt-get install -qq libboost-all-dev libblitz1-dev
- sudo apt-get install -qq libboost-all-dev libblitz1-dev texlive-latex-recommended texlive-latex-extra texlive-fonts-recommended
- if [ -n "${NUMPYSPEC}" ]; then sudo apt-get install -qq libatlas-dev libatlas-base-dev liblapack-dev gfortran; fi
- if [ -n "${NUMPYSPEC}" ]; then pip install --upgrade pip setuptools; fi
- if [ -n "${NUMPYSPEC}" ]; then pip install --find-links http://wheels.astropy.org/ --find-links http://wheels2.astropy.org/ --use-wheel numpy$NUMPYSPEC; fi
......
......@@ -2,14 +2,14 @@
.. Andre Anjos <andre.anjos@idiap.ch>
.. Thu 29 Aug 2013 16:07:57 CEST
.. image:: https://travis-ci.org/bioidiap/bob.blitz.svg?branch=master
:target: https://travis-ci.org/bioidiap/bob.blitz
.. image:: http://img.shields.io/badge/docs-stable-yellow.png
:target: http://pythonhosted.org/bob.blitz/index.html
.. image:: http://img.shields.io/badge/docs-latest-orange.png
:target: https://www.idiap.ch/software/bob/docs/latest/bioidiap/bob.blitz/master/index.html
.. image:: https://travis-ci.org/bioidiap/bob.blitz.svg?branch=master
:target: https://travis-ci.org/bioidiap/bob.blitz
.. image:: https://coveralls.io/repos/bioidiap/bob.blitz/badge.png
:target: https://coveralls.io/r/bioidiap/bob.blitz
.. image:: http://img.shields.io/github/tag/bioidiap/bob.blitz.png
:target: https://github.com/bioidiap/bob.blitz
.. image:: http://img.shields.io/pypi/v/bob.blitz.png
:target: https://pypi.python.org/pypi/bob.blitz
.. image:: http://img.shields.io/pypi/dm/bob.blitz.png
......@@ -19,55 +19,18 @@
Python bindings for Blitz++ Arrays
====================================
This package contains a set of Pythonic bindings to the popular Blitz/C++
library. It also provides a C/C++ API that allows your Python extensions to
leverage from the interfaces provided by this package. For more information,
consult the package documentation.
This package contains a set of Pythonic bindings to the popular Blitz/C++ library.
It also provides a C/C++ API that allows your Python extensions to leverage from the interfaces provided by this package.
Installation
------------
Install it through normal means, via PyPI or use ``zc.buildout`` to bootstrap
the package and run test units.
To install this package -- alone or together with other `Packages of Bob <https://github.com/idiap/bob/wiki/Packages>`_ -- please read the `Installation Instructions <https://github.com/idiap/bob/wiki/Installation>`_.
For Bob_ to be able to work properly, some dependent packages are required to be installed.
Please make sure that you have read the `Dependencies <https://github.com/idiap/bob/wiki/Dependencies>`_ for your operating system.
Documentation
-------------
For further documentation on this package, please read the `Stable Version <http://pythonhosted.org/bob.blitz/index.html>`_ or the `Latest Version <https://www.idiap.ch/software/bob/docs/latest/bioidiap/bob.blitz/master/index.html>`_ of the documentation.
For a list of tutorials on this or the other packages ob Bob_, or information on submitting issues, asking questions and starting discussions, please visit its website.
The latest version of the documentation can be found `here <https://www.idiap.ch/software/bob/docs/latest/bioidiap/bob.blitz/master/index.html>`_.
Otherwise, you can generate the documentation for this package yourself, after installation, using Sphinx::
$ sphinx-build -b html doc sphinx
This shall place in the directory ``sphinx``, the current version for the
documentation of the package.
Testing
-------
You can run a set of tests using the nose test runner::
$ nosetests -sv
You can run our documentation tests using sphinx itself::
$ sphinx-build -b doctest doc sphinx
You can test overall test coverage with::
$ nosetests --with-coverage --cover-package=bob.blitz
The ``coverage`` egg must be installed for this to work properly.
Development
-----------
To develop this package, install using ``zc.buildout``, using the buildout
configuration found on the root of the package::
$ python bootstrap.py
...
$ ./bin/buildout
Tweak the options in ``buildout.cfg`` to disable/enable verbosity and debug
builds.
.. _bob: https://www.idiap.ch/software/bob
......@@ -5,14 +5,17 @@
[buildout]
parts = scripts
eggs = bob.blitz
debug = true
verbose = true
extensions = bob.buildout
mr.developer
auto-checkout = *
develop = src/bob.extension
.
; options for bob.buildout extension
debug = true
verbose = true
newest = false
[sources]
bob.extension = git https://github.com/bioidiap/bob.extension
......
......@@ -280,5 +280,9 @@ intersphinx_mapping = {
numpy_manual: None,
}
from bob.extension.utils import link_documentation
intersphinx_mapping.update(link_documentation())
def setup(app):
pass
......@@ -93,6 +93,7 @@ setup(
},
classifiers = [
'Framework :: Bob',
'Development Status :: 4 - Beta',
'Intended Audience :: Developers',
'License :: OSI Approved :: BSD License',
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment