Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

Improve JSON Formatting in API Documentation #160

Closed
seancarroll opened this issue Feb 21, 2016 · 5 comments
Closed

Improve JSON Formatting in API Documentation #160

seancarroll opened this issue Feb 21, 2016 · 5 comments
Assignees

Comments

@seancarroll
Copy link

JSON formatting could use some love

@tomschenkjr
Copy link
Contributor

Thanks @seancarroll. Do you have some specific items you were looking for but weren't documented as well?

@seancarroll
Copy link
Author

JSON in https://opengrid.readthedocs.org/en/latest/OpenGrid%20API/ can be a wall of unformatted text that could use a bit of formatting to make it easier to understand the structure. Below is an example

screen shot 2016-02-21 at 11 01 06 pm

I think it would be helpful if it was formatted such as the following which I grabbed from http://docs.readthedocs.org/en/latest/api.html

screen shot 2016-02-21 at 11 11 52 pm

I've looked at mkdoc extensions as well as highlightjs but haven't been able to get the desired result yet.

@tomschenkjr
Copy link
Contributor

Thanks!

@tomschenkjr
Copy link
Contributor

@reve0716 - can you look at this and format the JSON? Swing by with any questions.

@rladines - FYI on this.

@reve0716
Copy link
Contributor

I'm currently formatting the API document.

# for free to join this conversation on GitHub. Already have an account? # to comment
Projects
None yet
Development

No branches or pull requests

3 participants