diff --git a/bob/extension/examples/bob.example.extension/README.rst b/bob/extension/examples/bob.example.extension/README.rst index 17b5fb8f6875f56f34f0cd510d5defdf4a5a9f87..4c67c5e7023ee58422a8386c78ef42068134aaab 100644 --- a/bob/extension/examples/bob.example.extension/README.rst +++ b/bob/extension/examples/bob.example.extension/README.rst @@ -1,18 +1,18 @@ .. vim: set fileencoding=utf-8 : -.. Fri Dec 23 13:41:36 CET 2016 +.. Mon 03 Jul 2017 11:48:20 CEST .. image:: http://img.shields.io/badge/docs-stable-yellow.svg - :target: http://pythonhosted.org/bob.example.extension/index.html + :target: https://www.idiap.ch/software/bob/docs/bob/bob.example.extension/stable/index.html .. image:: http://img.shields.io/badge/docs-latest-orange.svg - :target: https://www.idiap.ch/software/bob/docs/latest/bob/bob.example.extension/master/index.html + :target: https://www.idiap.ch/software/bob/docs/bob/bob.example.extension/master/index.html .. image:: https://gitlab.idiap.ch/bob/bob.example.extension/badges/master/build.svg :target: https://gitlab.idiap.ch/bob/bob.example.extension/commits/master +.. image:: https://gitlab.idiap.ch/bob/bob.example.extension/badges/master/coverage.svg + :target: https://gitlab.idiap.ch/bob/bob.example.extension/commits/master .. image:: https://img.shields.io/badge/gitlab-project-0000c0.svg :target: https://gitlab.idiap.ch/bob/bob.example.extension .. image:: http://img.shields.io/pypi/v/bob.example.extension.svg :target: https://pypi.python.org/pypi/bob.example.extension -.. image:: http://img.shields.io/pypi/dm/bob.example.extension.svg - :target: https://pypi.python.org/pypi/bob.example.extension ============================ @@ -39,12 +39,9 @@ provided by the distribution, build this package with:: Documentation and Further Information ------------------------------------- -Please refer to the latest Bob user guide, accessing from the `Bob website -<http://www.idiap.ch/software/bob>`_ for how to create your own packages based -on this example. In particular, the Section entitled `Bob Satellite Package -Development and Maintenance -<https://pythonhosted.org/bob.extension/guide.html>`_ -contains details on how to setup, build and roll out your code. +Refer to the latest Bob_ documentation for details. In particular, the +guide `Bob Package Development`_ contains details on how to setup, build and +roll out your own code. Contact @@ -58,3 +55,4 @@ development `mailing list`_. .. _bob: https://www.idiap.ch/software/bob .. _installation: https://www.idiap.ch/software/bob/install .. _mailing list: https://www.idiap.ch/software/bob/discuss +.. _bob package development: https://www.idiap.ch/software/bob/docs/bob/bob.extension/master/ diff --git a/bob/extension/examples/bob.example.library/README.rst b/bob/extension/examples/bob.example.library/README.rst index c6ebe7d2a15d0a45a2cc6f953b4193cf2818b8c0..2767d75594b72e953a64a96ed444c72ebfe40074 100644 --- a/bob/extension/examples/bob.example.library/README.rst +++ b/bob/extension/examples/bob.example.library/README.rst @@ -1,18 +1,18 @@ .. vim: set fileencoding=utf-8 : -.. Fri Dec 23 13:41:36 CET 2016 +.. Mon 03 Jul 2017 11:48:50 CEST .. image:: http://img.shields.io/badge/docs-stable-yellow.svg - :target: http://pythonhosted.org/bob.example.library/index.html + :target: https://www.idiap.ch/software/bob/docs/bob/bob.example.library/stable/index.html .. image:: http://img.shields.io/badge/docs-latest-orange.svg - :target: https://www.idiap.ch/software/bob/docs/latest/bob/bob.example.library/master/index.html + :target: https://www.idiap.ch/software/bob/docs/bob/bob.example.library/master/index.html .. image:: https://gitlab.idiap.ch/bob/bob.example.library/badges/master/build.svg :target: https://gitlab.idiap.ch/bob/bob.example.library/commits/master +.. image:: https://gitlab.idiap.ch/bob/bob.example.library/badges/master/coverage.svg + :target: https://gitlab.idiap.ch/bob/bob.example.library/commits/master .. image:: https://img.shields.io/badge/gitlab-project-0000c0.svg :target: https://gitlab.idiap.ch/bob/bob.example.library .. image:: http://img.shields.io/pypi/v/bob.example.library.svg :target: https://pypi.python.org/pypi/bob.example.library -.. image:: http://img.shields.io/pypi/dm/bob.example.library.svg - :target: https://pypi.python.org/pypi/bob.example.library ============================ @@ -31,7 +31,7 @@ Installation ------------ Follow our `installation`_ instructions. Then, using the Python interpreter -provided by the distribution, buildout this package:: +provided by the distribution, build this package with:: $ buildout @@ -39,12 +39,9 @@ provided by the distribution, buildout this package:: Documentation and Further Information ------------------------------------- -Please refer to the latest Bob user guide, accessing from the `Bob website -<http://www.idiap.ch/software/bob>`_ for how to create your own packages based -on this example. In particular, the Section entitled `Bob Satellite Package -Development and Maintenance -<https://pythonhosted.org/bob.extension/guide.html>`_ -contains details on how to setup, build and roll out your code. +Refer to the latest Bob_ documentation for details. In particular, the +guide `Bob Package Development`_ contains details on how to setup, build and +roll out your own code. Contact @@ -58,3 +55,4 @@ development `mailing list`_. .. _bob: https://www.idiap.ch/software/bob .. _installation: https://www.idiap.ch/software/bob/install .. _mailing list: https://www.idiap.ch/software/bob/discuss +.. _bob package development: https://www.idiap.ch/software/bob/docs/bob/bob.extension/master/ diff --git a/bob/extension/examples/bob.example.project/README.rst b/bob/extension/examples/bob.example.project/README.rst index 96608f8bad149da884d5ccf7b20aa4e8ba6133c8..931b710342f9b3b5d551a1cfd90ce4d64403c1c0 100644 --- a/bob/extension/examples/bob.example.project/README.rst +++ b/bob/extension/examples/bob.example.project/README.rst @@ -1,18 +1,18 @@ .. vim: set fileencoding=utf-8 : -.. Fri Dec 23 13:41:36 CET 2016 +.. Mon 03 Jul 2017 11:50:06 CEST .. image:: http://img.shields.io/badge/docs-stable-yellow.svg - :target: http://pythonhosted.org/bob.example.project/index.html + :target: https://www.idiap.ch/software/bob/docs/bob/bob.example.project/stable/index.html .. image:: http://img.shields.io/badge/docs-latest-orange.svg - :target: https://www.idiap.ch/software/bob/docs/latest/bob/bob.example.project/master/index.html + :target: https://www.idiap.ch/software/bob/docs/bob/bob.example.project/master/index.html .. image:: https://gitlab.idiap.ch/bob/bob.example.project/badges/master/build.svg :target: https://gitlab.idiap.ch/bob/bob.example.project/commits/master +.. image:: https://gitlab.idiap.ch/bob/bob.example.project/badges/master/coverage.svg + :target: https://gitlab.idiap.ch/bob/bob.example.project/commits/master .. image:: https://img.shields.io/badge/gitlab-project-0000c0.svg :target: https://gitlab.idiap.ch/bob/bob.example.project .. image:: http://img.shields.io/pypi/v/bob.example.project.svg :target: https://pypi.python.org/pypi/bob.example.project -.. image:: http://img.shields.io/pypi/dm/bob.example.project.svg - :target: https://pypi.python.org/pypi/bob.example.project ============================ @@ -39,12 +39,9 @@ provided by the distribution, build this package with:: Documentation and Further Information ------------------------------------- -Please refer to the latest Bob user guide, accessing from the `Bob website -<http://www.idiap.ch/software/bob>`_ for how to create your own packages based -on this example. In particular, the Section entitled `Bob Satellite Package -Development and Maintenance -<https://pythonhosted.org/bob.extension/guide.html>`_ -contains details on how to setup, build and roll out your code. +Refer to the latest Bob_ documentation for details. In particular, the +guide `Bob Package Development`_ contains details on how to setup, build and +roll out your own code. Contact @@ -58,3 +55,4 @@ development `mailing list`_. .. _bob: https://www.idiap.ch/software/bob .. _installation: https://www.idiap.ch/software/bob/install .. _mailing list: https://www.idiap.ch/software/bob/discuss +.. _bob package development: https://www.idiap.ch/software/bob/docs/bob/bob.extension/master/ diff --git a/bob/extension/test_utils.py b/bob/extension/test_utils.py index 09c73de22045ad7f681c4657d45570b2d53378cb..df11053e30a2693a1321b516927f3be32f04d599 100644 --- a/bob/extension/test_utils.py +++ b/bob/extension/test_utils.py @@ -190,8 +190,8 @@ package-z 'other.bob.package', ] - # test linkage to pythonhosted.org - server = "https://pythonhosted.org/%s/" + # test linkage to official documentation + server = "http://www.idiap.ch/software/bob/docs/bob/%s/master/" os.environ["BOB_DOCUMENTATION_SERVER"] = server result = link_documentation(additional_packages, stringio(f)) expected = [ @@ -204,23 +204,6 @@ package-z result = [k[0] for k in result.values()] nose.tools.eq_(sorted(result), sorted(expected)) - # test idiap server - server = "https://www.idiap.ch/software/bob/docs/latest/bob/%s/master/" - os.environ["BOB_DOCUMENTATION_SERVER"] = server - result = link_documentation(additional_packages, stringio(f)) - expected = [ - 'https://docs.python.org/%d.%d/' % sys.version_info[:2], - 'http://matplotlib.org/', - 'https://setuptools.readthedocs.io/en/latest/', - server % 'bob.extension', - server % 'gridtk', - ] - # SSL connection could not be established by the client - # See: https://secure.idiap.ch/bugzilla5/show_bug.cgi?id=12681 - # See: https://gitlab.idiap.ch/bob/bob.extension/issues/17 - # in this case and to circumvent the bug above, we keep the entry - #nose.tools.eq_(sorted(result.keys()), sorted(expected)) - finally: sys.stdout = _stdout diff --git a/bob/extension/utils.py b/bob/extension/utils.py index 35eaa9486c818305c2a87eb5e4d17d95dd50c6da..ffc190ae35a6fbd240aa5ce5f23bf06f38a2d942 100644 --- a/bob/extension/utils.py +++ b/bob/extension/utils.py @@ -383,7 +383,7 @@ def find_packages(directories=['bob']): return packages def link_documentation(additional_packages = ['python', 'numpy'], requirements_file = "../requirements.txt", server = None): - """Generates a list of documented packages on pythonhosted.org for the packages read from the "requirements.txt" file and the given list of additional packages. + """Generates a list of documented packages on our documentation server for the packages read from the "requirements.txt" file and the given list of additional packages. Parameters: @@ -398,7 +398,7 @@ def link_documentation(additional_packages = ['python', 'numpy'], requirements_f server : str or None The url to the server which provides the documentation. If ``None`` (the default), the ``BOB_DOCUMENTATION_SERVER`` environment variable is taken if existent. - If neither ``server`` is specified, nor a ``BOB_DOCUMENTATION_SERVER`` environment variable is set, the default ``"https://pythonhosted.org/%s"`` is used. + If neither ``server`` is specified, nor a ``BOB_DOCUMENTATION_SERVER`` environment variable is set, the default ``"http://www.idiap.ch/software/bob/docs/bob/%(name)s/%(version)s/"`` is used. """ @@ -498,7 +498,7 @@ def link_documentation(additional_packages = ['python', 'numpy'], requirements_f _add_scipy_index() _add_index('matplotlib', 'http://matplotlib.org/') _add_index('setuptools', 'https://setuptools.readthedocs.io/en/latest/') - _add_index('six', 'https://pythonhosted.org/six/') + _add_index('six', 'https://six.readthedocs.io') _add_index('sqlalchemy', 'https://docs.sqlalchemy.org/en/latest/') _add_index('docopt', 'http://docopt.readthedocs.io/en/latest/') _add_index('scikit-image', 'http://scikit-image.org/docs/dev/') @@ -510,7 +510,7 @@ def link_documentation(additional_packages = ['python', 'numpy'], requirements_f if "BOB_DOCUMENTATION_SERVER" in os.environ: server = os.environ["BOB_DOCUMENTATION_SERVER"] else: - server = "https://pythonhosted.org/%s" + server = "http://www.idiap.ch/software/bob/docs/bob/%(name)s/%(version)s/" # array support for BOB_DOCUMENTATION_SERVER # transforms "(file:///path/to/dir https://example.com/dir| http://bla )"