links to examples on PyPI page are broken
#699
Labels
bug
Something isn't working
Comments
Michael-J-Ward
added a commit
to Michael-J-Ward/datafusion-python
that referenced
this issue
May 15, 2024
PyPI otherwise renders these relative to the `datafusion-python` page, so when users currently get a 404 when they click on one of these links. Fixes apache#699
Merged
andygrove
pushed a commit
that referenced
this issue
May 15, 2024
* docs: link to examples using full URL in README PyPI otherwise renders these relative to the `datafusion-python` page, so when users currently get a 404 when they click on one of these links. Fixes #699 * docs: update project.urls in pyproject.toml * docs: update README with apache TLP URLs * docs u pdate docs/README.md with apache TLP URLs * docs: update index.rst with TLP URLs * docs: update to new branded logos
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Describe the bug
The relative links in the
README.mdget rendered relative to the PyPI page.So
./examples/sql-parquet.pygets rendered ashttps://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.
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
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.
The text was updated successfully, but these errors were encountered: