coralnet icon indicating copy to clipboard operation
coralnet copied to clipboard

API documentation: R and Python examples

Open StephenChan opened this issue 4 years ago • 0 comments

Branched from issue #190. We currently only have curl examples. That was good enough for Tony, but not sure about the NOAA programmers or any other potential API users yet.

Idea on how to lay out the examples without cluttering the docs too much:

include examples of a call in each language under each endpoint subsection. Ideally each in an expandable section although I'm not sure our support pages allow it?

They don't at this point. We could probably implement such a thing with moderate effort, though. We can always include HTML tags when writing Markdown, so we can delineate sections with <div class='section'> or something. Then we can customize the Django template for those pages, so that it runs some Javascript which does something special with those particular div elements.

StephenChan avatar Mar 27 '20 18:03 StephenChan