Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Viewing the plot-api documentation online #6

Closed
PHPirates opened this issue Jan 23, 2020 · 5 comments
Closed

Viewing the plot-api documentation online #6

PHPirates opened this issue Jan 23, 2020 · 5 comments
Assignees

Comments

@PHPirates
Copy link

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
Copy link
Collaborator

alshan commented Jan 23, 2020

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

For now please try to use this one.

@alshan alshan assigned alshan and ileasile and unassigned alshan Jan 23, 2020
@alshan
Copy link
Collaborator

alshan commented Aug 11, 2020

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.

@alshan alshan closed this as completed Aug 11, 2020
@2x2xplz
Copy link

2x2xplz commented Oct 6, 2020

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
Copy link
Collaborator

alshan commented Oct 6, 2020

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

@alshan
Copy link
Collaborator

alshan commented Oct 7, 2020

'htmlpreview' should be working now.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

4 participants