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

Move API documentation from Warehouse developer docs to PyPI user docs #16541

Closed
di opened this issue Aug 21, 2024 · 7 comments
Closed

Move API documentation from Warehouse developer docs to PyPI user docs #16541

di opened this issue Aug 21, 2024 · 7 comments
Assignees
Labels
documentation meta Meta issues (rollouts, etc)

Comments

@di
Copy link
Member

di commented Aug 21, 2024

Documentation for our APIs and datasets currently lives in our developer-facing docs: https://warehouse.pypa.io/api-reference/index.html

However, these are really end-user docs, and should live at https://docs.pypi.org/ instead.

@woodruffw
Copy link
Member

woodruffw commented Sep 27, 2024

Adding a roadmap:

Once each of these is moved/added, it might make sense to add redirects from the old dev-docs URLs to the new user-docs ones.

@di
Copy link
Member Author

di commented Nov 25, 2024

XML-RPC (N/A?)

I think it would be wise to not bother porting these docs.

Integration guide (N/A?)

I think this can probably get included in the top-level page at https://docs.pypi.org/api/

@woodruffw
Copy link
Member

All planned migrations are complete, so closing!

@di
Copy link
Member Author

di commented Dec 3, 2024

Should we add redirects from the old URLs?

@woodruffw
Copy link
Member

Should we add redirects from the old URLs?

Yep! I was trying to figure out a good way to do that in Sphinx but couldn't find one (there's a lot of ways to redirect to a different Sphinx doc, but not an arbitrary URL). I'll do some more looking here.

@woodruffw
Copy link
Member

https://documatt.com/sphinx-reredirects/usage.html might do the trick; I'll play around with that.

@woodruffw
Copy link
Member

#17213 has the redirects!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation meta Meta issues (rollouts, etc)
Projects
None yet
Development

No branches or pull requests

2 participants