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

[docs] R API docs not included in readthedocs PDF #5973

Closed
Sinansi opened this issue Jul 13, 2023 · 10 comments
Closed

[docs] R API docs not included in readthedocs PDF #5973

Sinansi opened this issue Jul 13, 2023 · 10 comments

Comments

@Sinansi
Copy link

Sinansi commented Jul 13, 2023

I downloaded the documentation PDF. The documentation date is July 13, 2023. The R API is not included in the documentation. Please, include R API in the pdf documentation.

Thank you!

@jameslamb
Copy link
Collaborator

Thanks for using LightGBM.

What does "downloaded the documentation PDF" mean, specifically? Can you please provide a link describing what you're referring to?

@Sinansi
Copy link
Author

Sinansi commented Jul 13, 2023

The link for the documentation.

https://lightgbm.readthedocs.io/en/stable/index.html

Scroll down and click on "Read the Docs", then go to "Downloads".

@jameslamb
Copy link
Collaborator

Interesting! I did not know readthedocs provided that.

You can view the R docs in your browser by following the "R API" link from that same page: https://lightgbm.readthedocs.io/en/stable/R/reference/

Or get a PDF of the R package's manual from CRAN: https://cran.r-project.org/web/packages/lightgbm/lightgbm.pdf


Out of curiosity... why do you need a PDF of the documentation? Your answer would help us to understand the value of spending time trying to figure out how to change our readthedocs configuration to include that.

@jameslamb jameslamb changed the title R API Documentation [docs] R API docs not included in readthedocs PDF Jul 13, 2023
@Sinansi
Copy link
Author

Sinansi commented Jul 13, 2023

Thats a good idea James. I will check it on CRAN. Although, I prefer to get the PDF from readthedocs, since it is usually more recent, and it is being a primary source, directly from your company.

I read the documentation on PDF because I convert the PDF into word, then I edit or summarize the word document to the part of the documentation that fit my needs. Reading from a website does not allow me to edit, neither does it allow me to add notes to the important parts of the documentation. Then finally, I paste the important notes in the code.

One reason I prefer R over Python, is that in R everything is in PDF.

@Sinansi
Copy link
Author

Sinansi commented Jul 13, 2023

I will use the CRAN PDF. Hopefully, they update it soon. You can close the case.

Thank you!

@jameslamb
Copy link
Collaborator

Thanks for taking the time to explain that, we really appreciate it! I'm sorry that the readthedocs PDF doesn't currently meet your needs.

I will use the CRAN PDF. Hopefully, they update it soon

CRAN is only updated when we push a new version of the library...which I'll hopefully be doing today.

I'll close this for now. Thanks again for using LightGBM!

@Sinansi
Copy link
Author

Sinansi commented Sep 9, 2023

Hello James, its been two months.
Could you please update R documentation on CRAN?
The last version on CRAN is 3.3.5 (2023-01-16)
https://cran.r-project.org/web/packages/lightgbm/index.html

@jameslamb
Copy link
Collaborator

CRAN rejected v4.0.0 of the R package twice because of the issue described in #5987.

The next release will also not go to CRAN bevause we haven't fixed that yet.

Please subscribe to that issue to be notified when it's resolved.

@Sinansi
Copy link
Author

Sinansi commented Sep 9, 2023

Thanks for the update. I will subscribe to the issue you linked.

Copy link

This issue has been automatically locked since there has not been any recent activity since it was closed. To start a new related discussion, open a new issue at https://github.com/microsoft/LightGBM/issues including a reference to this.

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Dec 13, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

No branches or pull requests

2 participants