From 06317134bcc80d92c1f50453140f752330652b55 Mon Sep 17 00:00:00 2001
From: Cuong Nguyen <128072568+can-anyscale@users.noreply.github.com>
Date: Wed, 14 Aug 2024 11:16:44 -0700
Subject: [PATCH] [doc][rllib] the rest of missing api references + lint
 checker (#47114)
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

Add the rest of missing API references for rllib. We can also now enable
the API policy lint checker for rllib, now that all missing references
are documented

Test:
- CI

<img width="1351" alt="Screenshot 2024-08-13 at 12 15 08 PM"
src="https://github.com/user-attachments/assets/cc1d1c8e-763e-4d2e-a7d1-28243a7fdbab">

Signed-off-by: can <can@anyscale.com>
---
 .buildkite/lint.rayci.yml                  | 1 +
 ci/ray_ci/doc/cmd_check_api_discrepancy.py | 5 +++++
 doc/source/rllib/package_ref/policy.rst    | 3 +--
 doc/source/rllib/package_ref/utils.rst     | 9 +++++++--
 4 files changed, 14 insertions(+), 4 deletions(-)

diff --git a/.buildkite/lint.rayci.yml b/.buildkite/lint.rayci.yml
index 4928799a856e..c51ba9c4275b 100644
--- a/.buildkite/lint.rayci.yml
+++ b/.buildkite/lint.rayci.yml
@@ -35,6 +35,7 @@ steps:
       - api_policy_check core
       - api_policy_check serve
       - api_policy_check data
+      - api_policy_check rllib
 
   - label: ":lint-roller: lint: linkcheck"
     instance_type: medium
diff --git a/ci/ray_ci/doc/cmd_check_api_discrepancy.py b/ci/ray_ci/doc/cmd_check_api_discrepancy.py
index becf4c71a9e9..79209e578eec 100644
--- a/ci/ray_ci/doc/cmd_check_api_discrepancy.py
+++ b/ci/ray_ci/doc/cmd_check_api_discrepancy.py
@@ -42,6 +42,11 @@
             "ray.remote_function.RemoteFunction",
         },
     },
+    "rllib": {
+        "head_modules": {"ray.rllib"},
+        "head_doc_file": "doc/source/rllib/package_ref/index.rst",
+        "white_list_apis": {},
+    },
 }
 
 
diff --git a/doc/source/rllib/package_ref/policy.rst b/doc/source/rllib/package_ref/policy.rst
index 48c18a4782cd..554fb069da93 100644
--- a/doc/source/rllib/package_ref/policy.rst
+++ b/doc/source/rllib/package_ref/policy.rst
@@ -26,8 +26,7 @@ which maps agent IDs to a policy ID.
     by sub-classing either of the available, built-in classes, depending on your
     needs.
 
-.. include::
-    policy/custom_policies.rst
+.. include:: policy/custom_policies.rst
 
 .. currentmodule:: ray.rllib
 
diff --git a/doc/source/rllib/package_ref/utils.rst b/doc/source/rllib/package_ref/utils.rst
index 3d56bb1cf6b8..3a2de512be72 100644
--- a/doc/source/rllib/package_ref/utils.rst
+++ b/doc/source/rllib/package_ref/utils.rst
@@ -248,10 +248,15 @@ Policy utilities
 Other utilities
 ~~~~~~~~~~~~~~~
 
-.. currentmodule:: ray.rllib.utils
+.. currentmodule:: ray.rllib
 
 .. autosummary::
    :nosignatures:
    :toctree: doc/
 
-   tensor_dtype.get_np_dtype
+   utils.tensor_dtype.get_np_dtype
+   common.CLIArguments
+   common.FrameworkEnum
+   common.SupportedFileType
+   core.rl_module.validate_module_id
+   train.load_experiments_from_file