Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Links in README don't render properly on PyPi project page #1160

Closed
misscoded opened this issue Jan 7, 2022 · 2 comments · Fixed by #1163
Closed

Links in README don't render properly on PyPi project page #1160

misscoded opened this issue Jan 7, 2022 · 2 comments · Fixed by #1163
Labels
docs M-T: Documentation work only good first issue Version: 3x
Milestone
3.14.0

Comments

@misscoded
Copy link
Contributor

The README has links that don't work when viewed from PyPi. An example, which uses /tutorial as a relative path, resulting in a 404. The Table of Content anchors also appear to not work as intended.

Links on the project page should be reviewed and updated to work properly.

The page URLs

Requirements

Please read the Contributing guidelines and Code of Conduct before creating this issue or pull request. By submitting, you are agreeing to those rules.
@misscoded misscoded added the docs M-T: Documentation work only label Jan 7, 2022
@seratch seratch added this to the 3.x milestone Jan 7, 2022
@ghost
Copy link

ghost commented Jan 8, 2022

I want to solve this issue.
Can you help me, how to generate the issue in my local environment.

@hirosassa
Copy link

hirosassa commented Jan 9, 2022 •
edited
Loading

There are several similar problems e.g. dbeatty10/dbt-mysql#51 / dhimmel/obonet#12 .
A workaround seems to be using absolute URL.

seratch added a commit to seratch/python-slack-sdk that referenced this issue Jan 21, 2022
@seratch
Fix slackapi#1160 Links in README don't render properly on PyPi proje…
d539030 
…ct page
@seratch seratch mentioned this issue Jan 21, 2022
Merged
16 tasks
@seratch seratch modified the milestones: 3.x, 3.14.0 Jan 21, 2022
seratch added a commit that referenced this issue Jan 21, 2022
@seratch
Fix #1160 Links in README don't render properly on PyPi project page (#…
1a1865a 
…1163)
@zhelinisivanesan zhelinisivanesan mentioned this issue Dec 19, 2022
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
docs M-T: Documentation work only good first issue Version: 3x
Projects
None yet
Milestone
3.14.0
Development

Successfully merging a pull request may close this issue.

Fix #1160 Links in README don't render properly on PyPi project page seratch/python-slack-sdk
3 participants
@seratch @hirosassa @misscoded