# Variables of the form ${<variable>} are substituted, currently the following
# list is supported:
#   - ${branch} (or {branch}) the name of the current branch
#   - ${url} (or {url}) github url of the current project
#   - ${project:<project_name>} base url of the documentation of <project_name>
#     based on intersphinx_mapping.
# These comments will also be removed.
defaults:
  numbered: False
  maxdepth: 6
root: index
subtrees:
  - caption: Install
    entries:
      - file: install/install.rst
        title: Install with pip
      - file: install/build-from-source.rst
        title: Build from source
  - caption: Reference
    entries:
      - url: https://lightgbm.readthedocs.io/en/v4.6.0/Python-Intro.html
        title: Python quick start (upstream)
      - url: https://lightgbm.readthedocs.io/en/v4.6.0/Python-API.html
        title: Python API (upstream)
  - caption: Tutorial
    entries:
      - url: https://github.com/ROCm/rocm-finance/tree/${branch}/examples/lightgbm
        title: Examples
  - caption: About
    entries:
      - file: about/license.rst
        title: License