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

Add Python examples for API v3 documentation #5935

Closed
humitos opened this issue Jul 16, 2019 · 5 comments
Closed

Add Python examples for API v3 documentation #5935

humitos opened this issue Jul 16, 2019 · 5 comments
Labels
Accepted Accepted issue on our roadmap Good First Issue Good for new contributors Improvement Minor improvement to code Needed: documentation Documentation is required

Comments

@humitos
Copy link
Member

humitos commented Jul 16, 2019

We already have cURL request examples for APIv3 docs at https://docs.readthedocs.io/en/latest/api/v3.html#get--api-v3-projects-

It would be awesome to have use sphinx-tabs to have multiple tabs. One with the cURL example we already have there and another Python tab with the same request using Python code with Slumber

If Slumber is not good enough for this, we can use just requests as the example from here https://docs.readthedocs.io/en/latest/guides/environment-variables.html

Ref: #5895 (comment)

@humitos humitos added Good First Issue Good for new contributors Improvement Minor improvement to code Needed: documentation Documentation is required Accepted Accepted issue on our roadmap labels Jul 16, 2019
@tapaswenipathak
Copy link
Contributor

Hi @humitos: Is the ticket open? Can I add a PR?

@humitos
Copy link
Member Author

humitos commented Jul 28, 2019

@tapaswenipathak yes, sure!

@dibyaaaaax
Copy link
Contributor

hey @humitos, can I work on this?

@humitos
Copy link
Member Author

humitos commented Dec 22, 2019

@dibyaaaaax sure! go ahead :)

@humitos
Copy link
Member Author

humitos commented Apr 14, 2020

This is already done in the linked and merged PR.

@humitos humitos closed this as completed Apr 14, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Accepted Accepted issue on our roadmap Good First Issue Good for new contributors Improvement Minor improvement to code Needed: documentation Documentation is required
Projects
None yet
Development

No branches or pull requests

3 participants