Commit a8be2a73 authored by Manuel Günther's avatar Manuel Günther

Applied latest Bob modifications to documentation

parent 8c6da7b6
language: python
matrix:
include:
- python: 2.6
- python: 2.7
env:
- secure: bCrXmS1k8aIOE8Ba6XuHyjUoQQPpYEC8kpTcMi9pNhyXRQyGEPLp85VgyfXga2Oxb73QcW1aW4AxGUxiR1OZjB4rBmKK2uKij2G2qq9uhcXkDqCzqqxslhtm3o8cxHEFNJWRhuSVVjS0m0RvaFuGRicdz7QdyHCLl29+Gqdkacs=
- secure: W81QkyB8I87JT6kqaW/eBYBngbtcpHXWXIQsBkjy06Z8V9gUGbUD5oWwCn6NKQ1hE1ZR/qELxsTtrfgvfiegCW9wci4qZzatq34DWvzKK20jacqn9hs0BnXCyI/+iQRf6vam1KAnvc4qmWzF/CfsuZqCku8TtU5ZtKk05D/K//0=
- python: 3.2
- python: 3.3
- python: 3.4
- python: 2.6
- python: 2.7
env:
- secure: bCrXmS1k8aIOE8Ba6XuHyjUoQQPpYEC8kpTcMi9pNhyXRQyGEPLp85VgyfXga2Oxb73QcW1aW4AxGUxiR1OZjB4rBmKK2uKij2G2qq9uhcXkDqCzqqxslhtm3o8cxHEFNJWRhuSVVjS0m0RvaFuGRicdz7QdyHCLl29+Gqdkacs=
- secure: W81QkyB8I87JT6kqaW/eBYBngbtcpHXWXIQsBkjy06Z8V9gUGbUD5oWwCn6NKQ1hE1ZR/qELxsTtrfgvfiegCW9wci4qZzatq34DWvzKK20jacqn9hs0BnXCyI/+iQRf6vam1KAnvc4qmWzF/CfsuZqCku8TtU5ZtKk05D/K//0=
- BOB_DOCUMENTATION_SERVER=https://www.idiap.ch/software/bob/docs/latest/bioidiap/%s/master
- python: 3.2
- python: 3.3
- python: 3.4
before_install:
- sudo add-apt-repository -y ppa:biometrics/bob
- sudo apt-get update -qq
......
......@@ -2,14 +2,14 @@
.. Andre Anjos <andre.anjos@idiap.ch>
.. Thu 30 Jan 08:46:53 2014 CET
.. image:: https://travis-ci.org/bioidiap/bob.extension.svg?branch=master
:target: https://travis-ci.org/bioidiap/bob.extension
.. image:: http://img.shields.io/badge/docs-stable-yellow.png
:target: http://pythonhosted.org/bob.extension/index.html
.. image:: http://img.shields.io/badge/docs-latest-orange.png
:target: https://www.idiap.ch/software/bob/docs/latest/bioidiap/bob.extension/master/index.html
.. image:: https://travis-ci.org/bioidiap/bob.extension.svg?branch=master
:target: https://travis-ci.org/bioidiap/bob.extension
.. image:: https://coveralls.io/repos/bioidiap/bob.extension/badge.png
:target: https://coveralls.io/r/bioidiap/bob.extension
.. image:: http://img.shields.io/github/tag/bioidiap/bob.extension.png
:target: https://github.com/bioidiap/bob.extension
.. image:: http://img.shields.io/pypi/v/bob.extension.png
:target: https://pypi.python.org/pypi/bob.extension
.. image:: http://img.shields.io/pypi/dm/bob.extension.png
......@@ -21,13 +21,16 @@
This package is part of the signal-processing and machine learning toolbox Bob_.
It provides a simple mechanism for using Bob_, or extending Bob_ by building packages using either a pure Python API, or even a mix of C++ and python.
Further documentation on this package can be found `here <https://www.idiap.ch/software/bob/docs/latest/bioidiap/bob.extension/master/index.html>`_.
Installation
------------
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 mus be installed.
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.extension/index.html>`_ or the `Latest Version <https://www.idiap.ch/software/bob/docs/latest/bioidiap/bob.extension/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.
.. _bob: https://www.idiap.ch/software/bob
......@@ -448,7 +448,7 @@ More detailed information are given `here <http://pythonhosted.org/an_example_py
2. Create and upload the documentation, following the instructions `here <https://pypi.python.org/pypi/Sphinx-PyPI-upload>`__::
$ ./bin/python setup.py build_sphinx --source-dir=doc --build-dir=build/doc --all-files
$ ./bin/python setup.py upload_sphinx --upload-dir=build/doc/html
$ ./bin/python setup.py upload_docs --upload-dir=build/doc/html
The link to the documentation will automatically be added to the PyPI page of your package.
Usually it is a good idea to check the documentation after building and before uploading.
......
......@@ -12,7 +12,7 @@ setup(
name="bob.extension",
version="2.0.0a0",
description="Helps projects building Python/C++ extensions for Bob",
description="Building of Python/C++ extensions for Bob",
url='http://github.com/bioidiap/bob.extension',
license="BSD",
author='Andre Anjos',
......@@ -25,11 +25,11 @@ setup(
namespace_packages=[
"bob",
],
],
install_requires=[
'setuptools',
],
],
classifiers = [
'Framework :: Bob',
......@@ -40,6 +40,6 @@ setup(
'Programming Language :: Python',
'Programming Language :: Python :: 3',
'Topic :: Software Development :: Libraries :: Python Modules',
],
],
)
)
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