dmlc / dmlc/xgboost

Integrate examples into documents.

Open
#7,478 0 comments 0 reactions 0 assignees View on GitHub
doc feature-request
Dominant language
C++
Stars
28.8k
Forks
8.9k
Avg merge
1d 12h
Merged PRs (30d)
54

Description

https://github.com/dmlc/xgboost/pull/7468 added support for sphinx gallery and integrates `guide-python` into the documents. We still have some other demos like dask, shap and survival etc.

- [ ] Integrate all examples. (https://github.com/dmlc/xgboost/pull/7530)
- [x] Revise cross-references to use rst ref. (https://github.com/dmlc/xgboost/pull/7522)
- [ ] Update some outdated examples like the basic walk-through. (https://github.com/dmlc/xgboost/pull/7753)
- [x] Check links in Python doc string and replace them with rst ref. (https://github.com/dmlc/xgboost/pull/7522)

Contributor guide

No contributing guide indexed for this repository

Research direction

Start with the Sphinx Gallery documentation integration and the existing guide-python documents. Review the dask, shap, survival, and basic walk-through examples listed in the issue, then verify that the remaining examples are integrated and the generated documentation links correctly.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.