Skip to content
This repository was archived by the owner on May 30, 2020. It is now read-only.

[Request] Package documentation link(s) #501

Closed
stantond opened this issue Aug 5, 2016 · 2 comments
Closed

[Request] Package documentation link(s) #501

stantond opened this issue Aug 5, 2016 · 2 comments

Comments

@stantond
Copy link

stantond commented Aug 5, 2016

I'm following up this issue on ReadTheDocs about browsing docs offline with 3rd party apps - it looks like no one asked anyone here for help, but the issue is still outstanding.

There's currently no way to map from here to documentation in a format other applications can use. Details of why this would be useful are in the above ticket, but essentially there are examples of documentation names being different to the package names.

pypi-legacy accepts three URLs from a user, Home page, Download URL and Bugtrack url. warehouse only takes url, meant for the homepage.

Is there room for optional documentation URLs (plural as docs may be in multiple places and a user can choose which they prefer)?

Also on warehouse here, as if this makes it in, it should of course be in the warehouse.

@ewdurbin
Copy link
Member

ewdurbin commented Aug 5, 2016

@stantond i think this is an excellent idea, but we'll need to implement it in warehouse first since it owns the database schema now. (they're sharing).

if you want to champion or implement this on the warehouse side, I'd encourage that. once implemented we can expose the field for edit/view within pypi-legacy easily.

@di
Copy link
Member

di commented Apr 4, 2018

This is now possible with the Project-URL metadata field, see an example here.

@di di closed this as completed Apr 4, 2018
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants