search

ITISFoundation / osparc-simcore

🐼 osparc-simcore simulation framework
https://osparc.io
MIT License
46 stars 27 forks source link

Front-end API documentation #571

Closed odeimaiz closed 5 years ago

odeimaiz commented 5 years ago

Publish front-end API documentation in Github pages. Follow Qooxdoo approach

oetiker commented 5 years ago

you mean this ? https://github.com/qooxdoo/qxl.apiviewer/blob/master/.travis.yml

odeimaiz commented 5 years ago

I had this in mind: https://github.com/qooxdoo/qooxdoo.github.io

But in the end what I would like to replicate is the API viewer

oetiker commented 5 years ago

look at the link I provided ... this is doing what you want ... the api viewer has recently been extracted into a contrib ... so now you should be able to follow the instructions here https://github.com/qooxdoo/qxl.apiviewer. This may require the latest compiler version ...

odeimaiz commented 5 years ago

Thanks @oetiker. Yes that's exactly what we need and after playing around with it, I also realized that the compiler version we use at the moment is not creating the api-viewer output. I will check what compiler-sdk combination works.

oetiker commented 5 years ago

or upgrade the compiler ... lots of good things have happened ... I was planning on creating a PR for this this week anyway