{"action":"created","issue":{"url":"https://api.github.com/repos/odlgroup/odl/issues/204","labels_url":"https://api.github.com/repos/odlgroup/odl/issues/204/labels{/name}","comments_url":"https://api.github.com/repos/odlgroup/odl/issues/204/comments","events_url":"https://api.github.com/repos/odlgroup/odl/issues/204/events","html_url":"https://github.com/odlgroup/odl/issues/204","id":124866134,"number":204,"title":"Doc warnings","user":{"login":"kohr-h","id":5030250,"avatar_url":"https://avatars.githubusercontent.com/u/5030250?v=3","gravatar_id":"","url":"https://api.github.com/users/kohr-h","html_url":"https://github.com/kohr-h","followers_url":"https://api.github.com/users/kohr-h/followers","following_url":"https://api.github.com/users/kohr-h/following{/other_user}","gists_url":"https://api.github.com/users/kohr-h/gists{/gist_id}","starred_url":"https://api.github.com/users/kohr-h/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/kohr-h/subscriptions","organizations_url":"https://api.github.com/users/kohr-h/orgs","repos_url":"https://api.github.com/users/kohr-h/repos","events_url":"https://api.github.com/users/kohr-h/events{/privacy}","received_events_url":"https://api.github.com/users/kohr-h/received_events","type":"User","site_admin":false},"labels":[{"url":"https://api.github.com/repos/odlgroup/odl/labels/documentation","name":"documentation","color":"bfe5bf"},{"url":"https://api.github.com/repos/odlgroup/odl/labels/needs%20improvement","name":"needs improvement","color":"eb6420"}],"state":"open","locked":false,"assignee":null,"milestone":null,"comments":1,"created_at":"2016-01-04T23:58:10Z","updated_at":"2016-01-05T00:00:11Z","closed_at":null,"body":"We have a couple of doc warnings currently. Many are of the type\r\n```\r\n/data/jenkins/workspace/odl-master-doc/odl/space/fspace.py:docstring of odl.space.fspace.FunctionSpace.__eq__:10: WARNING: more than one target found for 'any' cross-reference u'range': could be :std:term: or :py:attr:\r\n```\r\nand don't lead to any negative consequences.\r\n\r\nThere are, however some warnings indicating dead links. I'll list them here, we should try to fix them.\r\n\r\n**Internal dead links:**\r\n```\r\n/data/jenkins/workspace/odl-master-doc/odl/discr/discr_mappings.py:docstring of odl.discr.discr_mappings.GridCollocation._call:29: WARNING: py:obj reference target not found: TensorGrid.meshgrid\r\n/data/jenkins/workspace/odl-master-doc/odl/set/pspace.py:docstring of odl.set.pspace.ProductSpaceVector.ufunc:11: WARNING: py:obj reference target not found: NtuplesBaseUFuncs\r\n/data/jenkins/workspace/odl-master-doc/odl/set/pspace.py:docstring of odl.set.pspace.ProductSpaceVector.ufunc:13: WARNING: py:obj reference target not found: ProductSpaceUFuncs\r\n/data/jenkins/workspace/odl-master-doc/odl/space/cu_ntuples.py:docstring of odl.space.cu_ntuples.CudaFnVector.ufunc:9: WARNING: py:obj reference target not found: NtuplesBaseUFuncs\r\n/data/jenkins/workspace/odl-master-doc/odl/space/cu_ntuples.py:docstring of odl.space.cu_ntuples.CudaNtuplesVector.ufunc:9: WARNING: py:obj reference target not found: NtuplesBaseUFuncs\r\n/data/jenkins/workspace/odl-master-doc/odl/space/fspace.py:docstring of odl.space.fspace.FunctionSet.element:28: WARNING: py:obj reference target not found: TensorGrid.meshgrid\r\n```\r\nNot sure why these fail, they are all part of a `See Also` section, and the corresponding links at in other sections work.\r\n\r\n**External library warnings:**\r\n```\r\n/usr/lib/python2.7/site-packages/_pytest/mark.py:docstring of odl.util.testutils.skip_if_no_cuda:3: WARNING: py:class reference target not found: MarkInfo\r\n/usr/lib/python2.7/site-packages/_pytest/mark.py:docstring of odl.util.testutils.skip_if_no_cuda:3: WARNING: undefined label: excontrolskip (if the link has no caption the label must precede a section header)\r\n/usr/lib/python2.7/site-packages/_pytest/mark.py:docstring of odl.util.testutils.skip_if_no_pywavelets:3: WARNING: py:class reference target not found: MarkInfo\r\n/usr/lib/python2.7/site-packages/_pytest/mark.py:docstring of odl.util.testutils.skip_if_no_pywavelets:3: WARNING: undefined label: excontrolskip (if the link has no caption the label must precede a section header)\r\n/data/jenkins/workspace/odl-master-doc/doc/source/generated/odl.util.ufuncs.CudaNtuplesUFuncs.rst:1: WARNING: 'any' reference target not found: 2**p\r\n/data/jenkins/workspace/odl-master-doc/doc/source/generated/odl.util.ufuncs.CudaNtuplesUFuncs.rst:1: WARNING: 'any' reference target not found: p\r\n/data/jenkins/workspace/odl-master-doc/doc/source/generated/odl.util.ufuncs.CudaNtuplesUFuncs.rst:1: WARNING: 'any' reference target not found: x\r\n/data/jenkins/workspace/odl-master-doc/doc/source/generated/odl.util.ufuncs.CudaNtuplesUFuncs.exp2.rst:7: WARNING: 'any' reference target not found: 2**p\r\n/data/jenkins/workspace/odl-master-doc/doc/source/generated/odl.util.ufuncs.CudaNtuplesUFuncs.exp2.rst:7: WARNING: 'any' reference target not found: p\r\n/data/jenkins/workspace/odl-master-doc/doc/source/generated/odl.util.ufuncs.CudaNtuplesUFuncs.log2.rst:7: WARNING: 'any' reference target not found: x\r\n/data/jenkins/workspace/odl-master-doc/odl/util/ufuncs.py:docstring of odl.util.ufuncs.CudaNtuplesUFuncs.max:9: WARNING: py:obj reference target not found: numpy.max\r\n/data/jenkins/workspace/odl-master-doc/odl/util/ufuncs.py:docstring of odl.util.ufuncs.CudaNtuplesUFuncs.min:9: WARNING: py:obj reference target not found: numpy.min\r\n/data/jenkins/workspace/odl-master-doc/odl/util/ufuncs.py:docstring of odl.util.ufuncs.CudaNtuplesUFuncs.nextafter:9: WARNING: py:obj reference target not found: numpy.nextafter\r\n```\r\n\r\nMost of these are inherited from Numpy docstrings, they should be fixed upstream. We get the same for all flavors of Ufuncs, I cropped the output."},"comment":{"url":"https://api.github.com/repos/odlgroup/odl/issues/comments/168849072","html_url":"https://github.com/odlgroup/odl/issues/204#issuecomment-168849072","issue_url":"https://api.github.com/repos/odlgroup/odl/issues/204","id":168849072,"user":{"login":"kohr-h","id":5030250,"avatar_url":"https://avatars.githubusercontent.com/u/5030250?v=3","gravatar_id":"","url":"https://api.github.com/users/kohr-h","html_url":"https://github.com/kohr-h","followers_url":"https://api.github.com/users/kohr-h/followers","following_url":"https://api.github.com/users/kohr-h/following{/other_user}","gists_url":"https://api.github.com/users/kohr-h/gists{/gist_id}","starred_url":"https://api.github.com/users/kohr-h/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/kohr-h/subscriptions","organizations_url":"https://api.github.com/users/kohr-h/orgs","repos_url":"https://api.github.com/users/kohr-h/repos","events_url":"https://api.github.com/users/kohr-h/events{/privacy}","received_events_url":"https://api.github.com/users/kohr-h/received_events","type":"User","site_admin":false},"created_at":"2016-01-05T00:00:11Z","updated_at":"2016-01-05T00:00:11Z","body":"The `See Also` links can be fixed by using full path, not sure if we want that."}}