Relative Links at https://pypi.org/project/onnx/ not working

[andife]

Bug Report

Describe the bug

Relative Links at https://pypi.org/project/onnx/ not working.

Notes

Maybe make the links absolut for the wheel and Pypi

[xadupre]

Nothing has changed since February. It is possible to know more?

[andife]

Our readme has the line:

[ONNX intermediate representation spec](docs/IR.md)

which results in

[xadupre]

Thanks, it is clear now. We should use absolute links.

[jcwchen]

Thanks for catching this. To provide more history context: previously we thought relative link issue for displaying description in PyPI has been resolved from their end: #3961, but in fact this issue still exists: pypa/readme_renderer#163. I also think we should use absolute links in ReadMe.md for now.

[andife]

I have not investigated it now so, but maybe there is another possibility? Could you prepare the readme file for pypi? Which file is used there? Could you make the links absolute only in the upload process?

Or maybe adapt the readme better to the target (e.g. how onnx is compiled, might not matter if you get a package with pip).

=> but maybe that just adds too much unnecessary complexity ?

[xadupre]

It is doable by replacing the relative link before just before calling setup: https://github.com/onnx/onnx/blob/main/setup.py#L346.

[justinchuby]

I suggest we don’t do too much in setup.py since it will eventually become pyproject.toml