Improve maintainability of pkgdown website for R documentation - Githubissues

h2oai / h2o-3

H2O is an Open Source, Distributed, Fast & Scalable Machine Learning Platform: Deep Learning, Gradient Boosting (GBM) & XGBoost, Random Forest, Generalized Linear Modeling (GLM with Elastic Net), K-Means, PCA, Generalized Additive Models (GAM), RuleFit, Support Vector Machine (SVM), Stacked Ensembles, Automatic Machine Learning (AutoML), etc.

http://h2o.ai

Apache License 2.0

6.92k stars 2k forks source link

Improve maintainability of pkgdown website for R documentation #8313

Open exalate-issue-sync[bot] opened 1 year ago

exalate-issue-sync[bot] commented 1 year ago

Right now, when we add a new function to the R package, we have to manually edit the pkgdown template file: [https://github.com/h2oai/h2o-3/blob/master/h2o-r/h2o-package/pkgdown/_pkgdown.yml|https://github.com/h2oai/h2o-3/blob/master/h2o-r/h2o-package/pkgdown/_pkgdown.yml]

Here’s our options to make life a little easier:

We use the “default setting” of pkgdown where everything is in one section (similar output to what we have now), that can be re-generated automatically when new functions arise, apparently.
We continue to use “sections” and then we can add a lot of functions just using regex… we can add all the h2o.* functions easily with regex at least. Right now we are using sections (even though we just have one section with all the functions in it), and when you use sections, functions cannot be added automatically (other than through regex).

Here’s some info: [https://pkgdown.r-lib.org/articles/pkgdown.html#reference|https://pkgdown.r-lib.org/articles/pkgdown.html#reference]

h2o-ops commented 1 year ago

JIRA Issue Migration Info

Jira Issue: PUBDEV-7324 Assignee: New H2O Bugs Reporter: Erin LeDell State: Open Fix Version: N/A Attachments: N/A Development PRs: N/A