-
Notifications
You must be signed in to change notification settings - Fork 53
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
Comments
Thanks @seancarroll. Do you have some specific items you were looking for but weren't documented as well? |
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 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 I've looked at mkdoc extensions as well as highlightjs but haven't been able to get the desired result yet. |
Thanks! |
I'm currently formatting the API document. |
JSON formatting could use some love
The text was updated successfully, but these errors were encountered: