You are viewing a plain text version of this content. The canonical link for it is here.
Posted to github@datafusion.apache.org by "Michael-J-Ward (via GitHub)" <gi...@apache.org> on 2024/05/14 20:11:21 UTC
[I] links to `examples` on PyPI page are broken [datafusion-python]
Michael-J-Ward opened a new issue, #699:
URL: https://github.com/apache/datafusion-python/issues/699
**Describe the bug**
The relative links in the [README.md] get rendered relative to the PyPI page.
So `./examples/sql-parquet.py]` gets rendered as
https://pypi.org/project/datafusion/
https://pypi.org/project/datafusion/examples/sql-parquet.py
**Expected behavior**
The links should resolve to the github repository.
**Additional context**
This is a long-standing issue for [pypa/readme_renderer](https://github.com/pypa/readme_renderer/issues/163).
The standard solution appears to be using absolute links in your README like this:
https://github.com/apache/datafusion-python/blob/main/examples/sql-parquet.py
There may be fancier solutions
- [having a script re-write the readme just before build](https://github.com/pypa/readme_renderer/issues/163#issuecomment-1679601106)
- (maybe?) use [another tool](https://github.com/hynek/hatch-fancy-pypi-readme/)
**Related**
I found this trying to figure out what #687 meant. I don't know if this is what was meant by that issue.
--------
If everyone's fine with the absolute links in the README then I'll update with that.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@datafusion.apache.org.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: github-unsubscribe@datafusion.apache.org
For additional commands, e-mail: github-help@datafusion.apache.org
Re: [I] links to `examples` on PyPI page are broken [datafusion-python]
Posted by "andygrove (via GitHub)" <gi...@apache.org>.
andygrove closed issue #699: links to `examples` on PyPI page are broken
URL: https://github.com/apache/datafusion-python/issues/699
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@datafusion.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: github-unsubscribe@datafusion.apache.org
For additional commands, e-mail: github-help@datafusion.apache.org