search

JetBrains / lets-plot-kotlin

Grammar of Graphics for Kotlin
https://lets-plot.org/kotlin/
MIT License
437 stars 36 forks source link

Viewing the plot-api documentation online #6

Closed PHPirates closed 4 years ago

PHPirates commented 4 years ago

When I go to https://github.com/JetBrains/lets-plot-kotlin/blob/master/docs/guide/user_guide.ipynb and click on the geom_reference link to get to the documentation, I get a 404. I don't exactly know why, the link seems to be correct (when I hover over it). When I copy the url manually and visit https://render.githubusercontent.com/plot-api/docs/plot-api/jetbrains.lets-plot.geom/index.html then I get an 'Unknown type'.

For now I just render with htmlpreview: https://htmlpreview.github.io/?https://github.com/JetBrains/lets-plot-kotlin/blob/master/plot-api/docs/plot-api/index.html, but a proper solution would be convenient.

alshan commented 4 years ago

This looks like a half-baked adaptation of python lets-plot guide

For now please try to use this one.

alshan commented 4 years ago

All links in user_guide.ipynb must be fine now but this notebook should be opened in nbviewer for the links to work.

Both, the guide and the reference are accessible via links in the README.

2x2xplz commented 4 years ago

The API reference is not available via the link provided in the README.

Error: Cannot load https://raw.githubusercontent.com/JetBrains/lets-plot-kotlin/master/plot-api/docs/plot-api/index.html: 429 Too Many Requests

It does come up occasionally, but when trying to learn the library and 90% of requests to view the API are refused, it's rather frustrating.

alshan commented 4 years ago

@2x2xplz Seems like some issues with 'htmlpreview' : https://github.com/htmlpreview/htmlpreview.github.com/issues/92

alshan commented 4 years ago

'htmlpreview' should be working now.