EmbedAPIv3: docs for endpoint and guide updated #8566
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
ericholscher
approved these changes
Oct 11, 2021
docs/api/v3.rst
Outdated
| :>json string external: whether or not the page is hosted on Read the Docs or externally. | ||
|
|
||
| :query string url: full URL of the document (with optional fragment) to fetch content from. | ||
| :query string doctool: *optional* documentation tool key name used to generate the target documentation (e.g. ``sphinx``) |
There was a problem hiding this comment.
Is there a list of supported tools?
There was a problem hiding this comment.
Not officially, I'd say. However, all the tools that Read the Docs supports should be listed here: sphinx and mkdocs. That said, we are only doing special treatment for sphinx at this moment.
Co-authored-by: Eric Holscher <[email protected]>
|
@ericholscher I made some small updates to address your feedback. |
|
@humitos Looks good when link goes green 👍 |
|
The failed checks are some broken links in our docs. I'll address those separately. |
|
(Some were addressed by #8584) |
stsewd
reviewed
Oct 14, 2021
| .. http:get:: /api/v3/embed/ | ||
|
|
||
| Retrieve HTML-formatted content from documentation page or section. | ||
| Read :doc:`guides/embedding-content` to know more about how to use this endpoint. |
There was a problem hiding this comment.
This should be, that's breaking our CI
:doc:`/guides/embedding-content
There was a problem hiding this comment.
Yup, addressing in #8586
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
api/v3.rst(https://docs--8566.org.readthedocs.build/en/8566/api/v3.html#embed)