Skip to content

Commit 37cae7b

Browse files
committed
Description fixed for embed endpoint
1 parent 1f8cb1c commit 37cae7b

File tree

1 file changed

+6
-2
lines changed

1 file changed

+6
-2
lines changed

docs/api/v2.rst

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -323,14 +323,18 @@ Embed
323323

324324
.. http:get:: /api/v2/embed/
325325
326-
Retrieve details of builds ordered by most recent first
326+
Retrieve HTML-formatted content from documentation page or section.
327327

328328
**Example request**:
329329

330330
.. prompt:: bash $
331331

332332
curl https://readthedocs.org/api/v2/embed/?project=docs&version=latest&doc=features&path=features.html
333-
# or
333+
334+
or
335+
336+
.. prompt:: bash $
337+
334338
curl https://readthedocs.org/api/v2/embed/?url=https://docs.readthedocs.io/en/latest/features.html
335339

336340
**Example response**:

0 commit comments

Comments
 (0)