{"action":"created","issue":{"url":"https://api.github.com/repos/ODM2/ODM2RESTfulWebServices/issues/79","repository_url":"https://api.github.com/repos/ODM2/ODM2RESTfulWebServices","labels_url":"https://api.github.com/repos/ODM2/ODM2RESTfulWebServices/issues/79/labels{/name}","comments_url":"https://api.github.com/repos/ODM2/ODM2RESTfulWebServices/issues/79/comments","events_url":"https://api.github.com/repos/ODM2/ODM2RESTfulWebServices/issues/79/events","html_url":"https://github.com/ODM2/ODM2RESTfulWebServices/issues/79","id":294004939,"number":79,"title":"Add Sphinx documentation","user":{"login":"emiliom","id":742403,"avatar_url":"https://avatars0.githubusercontent.com/u/742403?v=4","gravatar_id":"","url":"https://api.github.com/users/emiliom","html_url":"https://github.com/emiliom","followers_url":"https://api.github.com/users/emiliom/followers","following_url":"https://api.github.com/users/emiliom/following{/other_user}","gists_url":"https://api.github.com/users/emiliom/gists{/gist_id}","starred_url":"https://api.github.com/users/emiliom/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/emiliom/subscriptions","organizations_url":"https://api.github.com/users/emiliom/orgs","repos_url":"https://api.github.com/users/emiliom/repos","events_url":"https://api.github.com/users/emiliom/events{/privacy}","received_events_url":"https://api.github.com/users/emiliom/received_events","type":"User","site_admin":false},"labels":[],"state":"open","locked":false,"assignee":null,"assignees":[],"milestone":null,"comments":3,"created_at":"2018-02-02T19:56:13Z","updated_at":"2018-02-02T21:36:36Z","closed_at":null,"author_association":"OWNER","body":"With a conda package now available, it seems like a good next step would be to create some minimal Sphinx documentation, mainly to document the REST API's -- which ones are available, their usage, etc.\r\n\r\nI realize there's a test endpoint somewhere, and its swagger interface provides good documentation. But relying on a test endpoint for general documentation may be a little frail? Would be cool if you could leverage some of that swagger stuff to \"export\" static HTML or markdown/ReST that could be incorporated into the Sphinx docs ...\r\n\r\nAnyway, not saying this is a high priority. Just creating this issue while the thought is in my head. We can discuss at the next BiGCZ/ODM2 call."},"comment":{"url":"https://api.github.com/repos/ODM2/ODM2RESTfulWebServices/issues/comments/362714838","html_url":"https://github.com/ODM2/ODM2RESTfulWebServices/issues/79#issuecomment-362714838","issue_url":"https://api.github.com/repos/ODM2/ODM2RESTfulWebServices/issues/79","id":362714838,"user":{"login":"emiliom","id":742403,"avatar_url":"https://avatars0.githubusercontent.com/u/742403?v=4","gravatar_id":"","url":"https://api.github.com/users/emiliom","html_url":"https://github.com/emiliom","followers_url":"https://api.github.com/users/emiliom/followers","following_url":"https://api.github.com/users/emiliom/following{/other_user}","gists_url":"https://api.github.com/users/emiliom/gists{/gist_id}","starred_url":"https://api.github.com/users/emiliom/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/emiliom/subscriptions","organizations_url":"https://api.github.com/users/emiliom/orgs","repos_url":"https://api.github.com/users/emiliom/repos","events_url":"https://api.github.com/users/emiliom/events{/privacy}","received_events_url":"https://api.github.com/users/emiliom/received_events","type":"User","site_admin":false},"created_at":"2018-02-02T21:36:36Z","updated_at":"2018-02-02T21:36:36Z","author_association":"OWNER","body":"Very nice!! Who cares that it's not Sphinx, specially if it saves effort by leveraging Swagger directly. This is what I was looking for.\r\n\r\nLonger term, it's still probably a good idea to create Sphinx docs, but for the REST API documentation it would just link to this Swagger page."}}
{"actor":{"display_login":"emiliom"}}