bob.bio.face and others are in requirements.txt of bob.bio.base

This is not good. We should think of a better solution. ping @andre.anjos @tiago.pereira @pkorshunov @mguenther

I just added in my branch.

It is the best way I found to fix the broken documentation links

Maybe add it in test-requirements.txt?

Do you have a better solution?

does not work

Just some context. This was added in this branch https://gitlab.idiap.ch/bob/bob.bio.base/tree/pre-release

Hey @tiago.pereira why can't I build the docs locally? I get this:

./bin/sphinx-build -W doc sphinx
Running Sphinx v1.4.6
Adding intersphinx source http://docs.python.org/2.7
Adding intersphinx source http://docs.scipy.org/doc/numpy-1.11.0
Adding intersphinx source http://docs.scipy.org/doc/scipy-0.18.0/reference
Adding intersphinx source https://pythonhosted.org/gridtk
Found documentation on https://pythonhosted.org/bob.blitz; adding intersphinx source
Found documentation on https://pythonhosted.org/bob.core; adding intersphinx source
Found documentation on https://pythonhosted.org/bob.db.base; adding intersphinx source
Found documentation on https://pythonhosted.org/bob.extension; adding intersphinx source
Found documentation on https://pythonhosted.org/bob.io.base; adding intersphinx source
Found documentation on https://pythonhosted.org/bob.learn.activation; adding intersphinx source
Found documentation on https://pythonhosted.org/bob.learn.em; adding intersphinx source
Found documentation on https://pythonhosted.org/bob.learn.linear; adding intersphinx source
Found documentation on https://pythonhosted.org/bob.math; adding intersphinx source
Found documentation on https://pythonhosted.org/bob.measure; adding intersphinx source
Found documentation on https://pythonhosted.org/bob.sp; adding intersphinx source
Found documentation on https://pythonhosted.org/bob.bio.face; adding intersphinx source
Found documentation on https://pythonhosted.org/bob.bio.gmm; adding intersphinx source
Found documentation on https://pythonhosted.org/bob.bio.spear; adding intersphinx source
Found documentation on https://pythonhosted.org/bob.bio.video; adding intersphinx source
Found documentation on https://pythonhosted.org/bob.db.youtube; adding intersphinx source
Found documentation on https://pythonhosted.org/setuptools; adding intersphinx source
loading pickled environment... not yet created
loading intersphinx inventory from https://pythonhosted.org/bob.extension/objects.inv...
loading intersphinx inventory from https://pythonhosted.org/bob.blitz/objects.inv...
loading intersphinx inventory from https://pythonhosted.org/bob.io.base/objects.inv...
loading intersphinx inventory from https://pythonhosted.org/bob.learn.em/objects.inv...
loading intersphinx inventory from https://pythonhosted.org/bob.measure/objects.inv...
loading intersphinx inventory from https://pythonhosted.org/bob.learn.linear/objects.inv...
loading intersphinx inventory from https://pythonhosted.org/bob.bio.video/objects.inv...
loading intersphinx inventory from https://pythonhosted.org/bob.core/objects.inv...
loading intersphinx inventory from https://pythonhosted.org/bob.learn.activation/objects.inv...
loading intersphinx inventory from http://docs.scipy.org/doc/scipy-0.18.0/reference/objects.inv...
loading intersphinx inventory from https://pythonhosted.org/bob.db.youtube/objects.inv...
loading intersphinx inventory from https://pythonhosted.org/bob.bio.gmm/objects.inv...
loading intersphinx inventory from https://pythonhosted.org/setuptools/objects.inv...

Warning, treated as error:
WARNING: intersphinx inventory 'https://pythonhosted.org/setuptools/objects.inv' not fetchable due to <class 'urllib2.HTTPError'>: HTTP Error 404: Not Found

remove the -W, so you will see all the warnings. This option makes the build stop in the first warning

But why this warning does not happen in the CI but in my laptop?

I dont't know. don't have this warning

weird; if you do wget https://pythonhosted.org/setuptools/objects.invyou get 404

your laptop is consistent at least

I created an environment with our bob.admin/install/from-scratch.sh script and now it works. Hail to stable conda installations :)

The intersphinx documentation for other bob.bio packages should only be listed in the doc/conf.py : https://gitlab.idiap.ch/bob/bob.bio.base/blob/master/doc/conf.py#L220 I am sure that I had the packages listed here https://github.com/bioidiap/bob.bio.base/blob/master/doc/conf.py#L249, I have no clue, why they have been removed.

There, you can list all packages that you want the documentation to be linked against, but which you do not depend on. I had the same in several other packages, it might have been removed from there, too.

Why setuptools/objects.inv does not exits, is clear: try to access the setuptools webpage: http://pythonhosted.org/setuptools/ It tells you, where it moved. You should be able to adapt the link here: https://gitlab.idiap.ch/bob/bob.extension/blob/master/bob/extension/utils.py#L441 by adding a new option here. Or wait, maybe it will get solved automatically...

As I said, there was something wrong with my conda environment now the setuptools error is fixed.

Anyways, my comment was more generic, talking about the original issue here. There is no need to put the bob.bio packages into the requirements.txt or test-requirements.txt just in order to get the documentation linked. Just re-add the packages in the link_documentation list inside conf.py.

The intersphinx documentation for other bob.bio packages should only be listed in the doc/conf.py : https://gitlab.idiap.ch/bob/bob.bio.base/blob/master/doc/conf.py#L220 I am sure that I had the packages listed here https://github.com/bioidiap/bob.bio.base/blob/master/doc/conf.py#L249, I have no clue, why they have been removed.

There, you can list all packages that you want the documentation to be linked against, but which you do not depend on. I had the same in several other packages, it might have been removed from there, too.

The instructions that we had was to replace conf.py with a default one: https://gitlab.idiap.ch/bob/bob.admin/tree/master/templates#6-docconfpy

ok @tiago.pereira things are green now. I'll leave the rest to you.

I guess I missed this problem on Friday but what is the deal with documentation? Is this issue described anywhere? Basically, I want to understand the problem you are trying to solve by adding references to other packages into bob.bio.base.

Hey @mguenther,

The intersphinx documentation for other bob.bio packages should only be listed in the doc/conf.py : https://gitlab.idiap.ch/bob/bob.bio.base/blob/master/doc/conf.py#L220 I am sure that I had the packages listed here https://github.com/bioidiap/bob.bio.base/blob/master/doc/conf.py#L249, I have no clue, why they have been removed.

I think this was removed by mistake. Just added back to see if will work (https://gitlab.idiap.ch/bob/bob.bio.base/blob/pre-release/doc/conf.py#L220).

A generic solution would be to append this requirements in the test-requirements.txt and make the conf.py load them.

Thanks for the fix @amohammadi

They are not really test-requirements.txt.

no, but it fits well there.

Furthermore, it is a way to not have a customized conf.py

But still, I think it's gonna create a circular dependency especially if it were in a conda package.

SO, what about having another file, where we have the documentation-dependencies that are automatically read, when the file exists? This would avoid changing the conf.py and removed the circular dependency.

Works too, but I dont't know. Our packages are becoming complex.

Several elements that people in the office have to know in order to make a "bob" package.

I patched the conf.py 896fdf4b and added a file called documentation-requirements.txt.

This file is not mandatory. Can I replace the sphinx-conf.py in https://gitlab.idiap.ch/bob/bob.admin/tree/master/templates ??

Please send a MR, will check.

Hi @tiago.pereira I was thinking a file named like links.txt in the doc folder would be more appropriate.

Is it sensible to have a base package pointing to derivative work?

what do you mean @andre.anjos ?

Why does this package need to point to other packages that depend on this one?

I think this was solved. Thanks

Status changed to closed