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

Invalid documentation URLs on PyPI #15

Closed
fmigneault opened this issue May 4, 2024 · 0 comments · Fixed by #22
Closed

Invalid documentation URLs on PyPI #15

fmigneault opened this issue May 4, 2024 · 0 comments · Fixed by #22
Assignees
Labels
bug Something isn't working documentation Improvements or additions to documentation

Comments

@fmigneault
Copy link
Collaborator

fmigneault commented May 4, 2024

🐛 Bug Report

All relative references to local files or anchors within the README do no resolve on https://pypi.org/project/stac-model/.

For example, the Best Practices link points at https://pypi.org/project/stac-model/best-practices.md instead of https://github.com/crim-ca/mlm-extension/blob/main/best-practices.md.

Anchors like #task-enum points at https://pypi.org/project/stac-model/#task-enum, which does not resolve because PyPI does not seem to generate the link references for the header sections.

🔬 How To Reproduce

Steps to reproduce the behavior:

  1. Go on the PyPI page.
  2. Click any link referring to contents hosted by this repository.

📈 Expected behavior

All relative links should be updated with explicit URL to the files so they are resolved correctly, no matter where the README source is hosted from.

@fmigneault fmigneault added bug Something isn't working documentation Improvements or additions to documentation labels May 4, 2024
fmigneault added a commit that referenced this issue May 13, 2024
@fmigneault fmigneault mentioned this issue May 13, 2024
10 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants