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.

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

A dead link on PyPI for the contributions and feedback #3093

Closed
galaxy4public opened this issue Jan 26, 2023 · 3 comments · Fixed by #3094
Closed

A dead link on PyPI for the contributions and feedback #3093

galaxy4public opened this issue Jan 26, 2023 · 3 comments · Fixed by #3094
Labels

Comments

@galaxy4public
Copy link
Contributor

I just stumbled upon Pelican's page in PyPI and found that the link for the contributions and feedback is dead. Perhaps, it needs to be updated?

@justinmayer
Copy link
Member

Nice catch. If you look at the README.rst source, you'll see that the link isn't exactly dead but refers to a local file (CONTRIBUTING.rst) that sits alongside the README.rst file. I'm sure there is a better way to handle that link such that it works well in all cases, including on the PyPI project page, but I don't use reStructuredText enough to know how to handle that well.

Anyone know how to fix it appropriately?

@kurtmckee
Copy link
Contributor

README.rst is injected into the package while setup.py is running.

The contents could be transformed using something like README.replace("<CONTRIBUTING.rst>", "$ABSOLUTE_URL") or similar. (Likely $ABSOLUTE_URL will be the rendered file on Read the Docs.)

@justinmayer
Copy link
Member

Thanks for the suggestion, Kurt. Any chance you might be willing to submit a pull request for this fix? 😊

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants