-
-
Notifications
You must be signed in to change notification settings - Fork 83
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: Use sphinxcontrib-httpexample and convert existing examples #248
Merged
Conversation
This file contains 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
(one for the corresponding request, one for the response).
to have a valid request line.
6df7f70
to
5642255
Compare
df63732
to
72151a7
Compare
datakurre
approved these changes
Mar 5, 2017
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
👍
tisto
approved these changes
Mar 6, 2017
lukasgraf
added a commit
that referenced
this pull request
Mar 7, 2017
lukasgraf
added a commit
that referenced
this pull request
Mar 7, 2017
lukasgraf
added a commit
that referenced
this pull request
Mar 8, 2017
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.
Use
sphinxcontrib-httpexample
and convert existing examples in documentation to use the new directive.Example Docs Build
Also
HTTP/1.1
to the request/response line in order to make examples valid HTTPContent-Type
header for requests that have a bodyAuthorization
header when dumping requestsTODO (in follow-up PRs):
sphinxcontrib-osexample
base example requests. These didn't have a corresponding file indocs/source/_json
that could be used withsphinxcontrib-httpexample
, so those will need to be produced using a "test" intest_documentation.py
first, and then converted_json
to something more meaningful (_httpexamples
?)