.. twinkle documentation file,
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Twinkle DOCUMENTATION
========================

.. toctree::
   :maxdepth: 1
   :caption: Usage Guide

   Usage Guide/Quick-Start.md
   Usage Guide/Installation.md
   Usage Guide/Server and Client/index.rst
   Usage Guide/NPU-Support.md
   Usage Guide/Train-as-a-Service.md
   Usage Guide/Introduction-with-Qwen3.5.md

.. toctree::
   :maxdepth: 2
   :caption: Components

   Components/Dataset/index.rst
   Components/Data Format/index.rst
   Components/Template/index.rst
   Components/Preprocessor and Filter/index.rst
   Components/Data Loading/index.rst
   Components/Task Processor/index.rst
   Components/Model/index.rst
   Components/Sampler/index.rst
   Components/Reward/index.rst
   Components/Advantage/index.rst
   Components/Gym/index.rst
   Components/Hub/index.rst
   Components/Checkpoint Engine/index.rst
   Components/Metrics/index.rst
   Components/Loss/index.rst
   Components/Loss Scale/index.rst
   Components/LRScheduler/index.rst
   Components/Patch/index.rst
   Components/Plugin/index.rst
   Components/Kernel/index.rst
   Components/Training Middleware/index.rst

Indices and tables
==================
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`