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

docs: redirect all old API docs to new equivalents #17213

Merged
merged 5 commits into from
Dec 3, 2024

Conversation

woodruffw
Copy link
Member

@woodruffw woodruffw commented Dec 3, 2024

This uses sphinx-reredirects to redirect most of the /api-reference/* hierarchy to the new user docs.

The exception is /api-reference/xml-rpc, which was intentionally not migrated and is still present at its original URL. To ensure that URL is still discoverable, it's now direct linked at the top-level index.rst in the dev-docs, where /api-reference/index.rst was previously linked.

docs/dev/api-reference/index.rst Outdated Show resolved Hide resolved
Signed-off-by: William Woodruff <[email protected]>
docs/dev/api-reference/index.rst Outdated Show resolved Hide resolved
docs/dev/conf.py Outdated Show resolved Hide resolved
Co-authored-by: Dustin Ingram <[email protected]>
docs/dev/conf.py Outdated Show resolved Hide resolved
@di di enabled auto-merge (squash) December 3, 2024 19:21
@di di merged commit c9231a6 into pypi:main Dec 3, 2024
20 checks passed
@di di deleted the ww/redirect-old-api-docs branch December 3, 2024 19:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants