Skip to content

Commit 4c89a8a

Browse files
committed
Blog post: deprecation of embed API v2
Ref readthedocs/readthedocs.org#10677
1 parent 0dab19e commit 4c89a8a

File tree

2 files changed

+23
-0
lines changed

2 files changed

+23
-0
lines changed
34.8 KB
Loading
+23
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
title: Deprecation and removal of embed API v2
2+
date: November 21, 2024
3+
description: Announcing the deprecation and removal of embed API v2.
4+
category: Changelog
5+
tags: api, deprecation
6+
authors: Santos Gallegos
7+
status: published
8+
image: /images/deprecated-embed-api-v2.jpg
9+
image_credit: Photo by <a href="https://unsplash.com/@jplenio?utm_content=creditCopyText&utm_medium=referral&utm_source=unsplash">Johannes Plenio</a> on <a href="https://unsplash.com/photos/brown-boat-near-dock-qkfxBc2NQ18?utm_content=creditCopyText&utm_medium=referral&utm_source=unsplash">Unsplash</a>
10+
11+
We are announcing the deprecation and removal of embed API v2.
12+
Our old API has been replaced by [embed API v3](https://docs.readthedocs.io/en/stable/api/v3.html#embed),
13+
which offers the same features, and it works for all types of projects, not just Sphinx.
14+
15+
If you are using our [sphinx-hoverxref](https://sphinx-hoverxref.readthedocs.io/en/stable/) extension,
16+
please update to the latest version to keep the extension working.
17+
18+
Deprecation timeline
19+
--------------------
20+
21+
- **Monday, December 9, 2024**: Temporarily disable embed API v2 for all users for 12 hours, from 00:01 PST to 11:59 PST.
22+
- **Monday, January 13, 2025**: Temporarily disable embed API v2 for all users for 24 hours, from 00:01 PST to 23:59 PST.
23+
- **Monday, January 20, 2025**: Permanently remove embed API v2 permanently.

0 commit comments

Comments
 (0)