8000 links to `examples` on PyPI page are broken · Issue #699 · apache/datafusion-python · GitHub
[go: up one dir, main page]

Skip to content
links to examples on PyPI page are broken #699
Closed
@Michael-J-Ward

Description

@Michael-J-Ward

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.

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.

Metadata

Metadata

Assignees

No one assigned

    Labels

    bugSomething isn't working

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions

      0