NDCube 2.1.1 release broke Specutils docs build

[pllim]

Describe the bug

Follow up of #598 to see if #600 fixed the problem. Now see other warnings.

Example log: https://readthedocs.org/projects/specutils/builds/19743252/

ndcube/ndcube.py:docstring of ndcube.ndcube.NDCubeBase.crop:35: WARNING: py:obj reference target not found: ndcube..ndcube.NDCubeABC
ndcube/ndcube.py:docstring of ndcube.ndcube.NDCubeBase.crop_by_values:1: WARNING: py:obj reference target not found: ndcube.NDCube.crop()
ndcube/ndcube.py:docstring of ndcube.ndcube.NDCubeBase.crop_by_values:39: WARNING: py:obj reference target not found: ndcube.ndcube.NDCubeABC
ndcube/ndcube.py:docstring of ndcube.ndcube.NDCube.rebin:28: WARNING: py:obj reference target not found: ndcube.utils.cube.propagate_rebin_uncertainty
ndcube/ndcube.py:docstring of ndcube.ndcube.NDCube.rebin:99: WARNING: py:obj reference target not found: ndcube.NDCube.rebin
ndcube/ndcube.py:docstring of ndcube.ndcube.NDCubeBase.reproject_to:7: WARNING: py:obj reference target not found: 'interpolation'
ndcube/ndcube.py:docstring of ndcube.ndcube.NDCubeBase.reproject_to:7: WARNING: py:obj reference target not found: reproject.reproject_interp
ndcube/ndcube.py:docstring of ndcube.ndcube.NDCubeBase.reproject_to:7: WARNING: py:obj reference target not found: 'adaptive'
ndcube/ndcube.py:docstring of ndcube.ndcube.NDCubeBase.reproject_to:7: WARNING: py:obj reference target not found: reproject.reproject_adaptive
ndcube/ndcube.py:docstring of ndcube.ndcube.NDCubeBase.reproject_to:7: WARNING: py:obj reference target not found: 'exact'
ndcube/ndcube.py:docstring of ndcube.ndcube.NDCubeBase.reproject_to:7: WARNING: py:obj reference target not found: reproject.reproject_exact
ndcube/ndcube.py:docstring of ndcube.ndcube.NDCubeBase.reproject_to:19: WARNING: py:obj reference target not found: True`
ndcube/ndcube.py:docstring of ndcube.ndcube.NDCubeBase.reproject_to:46: WARNING: py:obj reference target not found: reproject.reproject_interp
ndcube/ndcube.py:docstring of ndcube.ndcube.NDCubeBase.reproject_to:48: WARNING: py:obj reference target not found: reproject.reproject_adaptive
ndcube/ndcube.py:docstring of ndcube.ndcube.NDCubeBase.reproject_to:50: WARNING: py:obj reference target not found: reproject.reproject_exact
ndcube/ndcube.py:docstring of ndcube.ndcube.NDCube.to:25: WARNING: py:obj reference target not found: ǸDCube

To Reproduce

Run specutils doc build with ndcube 2.1.1 and turn warnings into errors.

Screenshots

N/A

System Details

See RTD log above.

Installation method

pip

[pllim]

Okay, I am not going crazy... these are real formatting errors.

ndcube/ndcube/ndcube.py

Line 215 in 6425f7c

result: `~ndcube..ndcube.NDCubeABC`

[nabobalis]

We currently do not run nitpicky on ndcube. I can try to patch these sometime this weekend.

[nabobalis]

So while I have #607 in draft and with nitpicky on and fixed as far as I can tell.

Specutils fails with:

/home/nabil/Git/ndcube/ndcube/ndcube.py:docstring of ndcube.ndcube.NDCubeBase.axis_world_coords_values:1: WARNING: py:meth reference target not found: ndcube.NDCube.axis_world_coords
/home/nabil/Git/ndcube/ndcube/ndcube.py:docstring of ndcube.ndcube.NDCubeBase.crop:35: WARNING: py:obj reference target not found: ndcube.NDCubeABC
/home/nabil/Git/ndcube/ndcube/ndcube.py:docstring of ndcube.ndcube.NDCubeBase.crop_by_values:39: WARNING: py:obj reference target not found: ndcube.NDCubeABC
/home/nabil/Git/ndcube/ndcube/ndcube.py:docstring of ndcube.ndcube.NDCube.rebin:28: WARNING: py:obj reference target not found: ndcube.utils.cube.propagate_rebin_uncertainties
/home/nabil/Git/ndcube/ndcube/ndcube.py:docstring of ndcube.ndcube.NDCube.rebin:99: WARNING: py:meth reference target not found: ndcube.NDCube.rebin

These are strange as they correctly link in my draft PR. Clearly I am missing something.

and

/home/nabil/Git/ndcube/ndcube/visualization/mpl_plotter.py:docstring of ndcube.visualization.mpl_plotter.MatplotlibPlotter.plot:30: WARNING: py:obj reference target not found: mpl_animators.ArrayAnimatorWCS
/home/nabil/Git/ndcube/ndcube/ndcube.py:docstring of ndcube.ndcube.NDCubeBase.reproject_to:7: WARNING: py:obj reference target not found: reproject.reproject_interp
/home/nabil/Git/ndcube/ndcube/ndcube.py:docstring of ndcube.ndcube.NDCubeBase.reproject_to:7: WARNING: py:obj reference target not found: reproject.reproject_adaptive
/home/nabil/Git/ndcube/ndcube/ndcube.py:docstring of ndcube.ndcube.NDCubeBase.reproject_to:7: WARNING: py:obj reference target not found: reproject.reproject_exact
/home/nabil/Git/ndcube/ndcube/ndcube.py:docstring of ndcube.ndcube.NDCubeBase.reproject_to:46: WARNING: py:obj reference target not found: reproject.reproject_interp
/home/nabil/Git/ndcube/ndcube/ndcube.py:docstring of ndcube.ndcube.NDCubeBase.reproject_to:48: WARNING: py:obj reference target not found: reproject.reproject_adaptive
/home/nabil/Git/ndcube/ndcube/ndcube.py:docstring of ndcube.ndcube.NDCubeBase.reproject_to:50: WARNING: py:obj reference target not found: reproject.reproject_exact

The reproject issues need reproject and mpl_animators adding to the intersphinx_mapping as far as I can tell. You can add them to the nitpick ignore file instead.

As a result of this, I opened astropy/specutils#1041 to hopefully "fix" any issues on that side.

[DanRyanIrish]

Has this been resolved?

[nabobalis]

Has this been resolved?

If you review and merge my PR.

[DanRyanIrish]

I'm on it!

[pllim]

Hello, is this resolved?

[nabobalis]

I am still waiting for #607 to be reviewed and merged. Then I will re-update my PR on specutils.

Sorry for the delay.

[nabobalis]

#607 was merged and I tagged a 2.1.2 release.

I am going to close this and hope that the tracking PR on specutils is enough.

[pllim]

Thank you!