generate static documentation on github from openapi.json

[ltalirz]

No description provided.

[dwinston]

One option is to just provide a link such as https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/Materials-Consortia/optimade-python-tools/master/openapi.json.

[ltalirz]

I like this option, and it is hosted on github as well.

Can still make sense to have way to show the docs locally for development purposes.
Github pages are kind of optional at this point...

[ltalirz]

Here the same from swagger.io (thanks to @fekad )
https://petstore.swagger.io/?url=https://raw.githubusercontent.com/Materials-Consortia/optimade-python-tools/master/openapi.json#/operation/get_structures_structures_get

[ltalirz]

here the editor for looking at the JSON and the documentation side-by-side
https://editor.swagger.io/?url=https://raw.githubusercontent.com/Materials-Consortia/optimade-python-tools/master/openapi.json#/operation/get_structures_structures_get

[ltalirz]

@dwinston since there is an open PR #46 for this, can we perhaps reach a decision on whether to merge this or not?
After whatever decision is taken, this issue can be closed.

[dwinston]

@ltalirz okay, I'll take a closer look at the PR tomorrow. I suspect the perfect is the enemy of the good here, and I will opt to approve.

[dwinston]

I left feedback on PR #46. I'd like to close this issue, as we have "instant" links to pretty-view the openapi.json spec in our README.