From 048e820d3d9f89c36cec1c74009a3101eda5337b Mon Sep 17 00:00:00 2001
From: Linlang <30293408+SunsetWolf@users.noreply.github.com>
Date: Fri, 9 Aug 2024 15:23:56 +0800
Subject: [PATCH] fix_docs_warning (#195)

---
 Makefile                        | 2 +-
 docs/scens/data_agent_fin.rst   | 3 ++-
 docs/scens/data_copilot_fin.rst | 3 ++-
 docs/ui.rst                     | 1 +
 4 files changed, 6 insertions(+), 3 deletions(-)

diff --git a/Makefile b/Makefile
index f029a36c..f12e5f95 100644
--- a/Makefile
+++ b/Makefile
@@ -189,7 +189,7 @@ release-notes:
 
 # Build documentation only from rdagent.
 docs-gen:
-	$(PIPRUN) python -m sphinx.cmd.build docs $(PUBLIC_DIR)
+	$(PIPRUN) python -m sphinx.cmd.build -W docs $(PUBLIC_DIR)
 
 # Generate mypy reports.
 docs-mypy: docs-gen
diff --git a/docs/scens/data_agent_fin.rst b/docs/scens/data_agent_fin.rst
index d53e4c56..e0ef74d4 100644
--- a/docs/scens/data_agent_fin.rst
+++ b/docs/scens/data_agent_fin.rst
@@ -125,4 +125,5 @@ The following environment variables can be set in the `.env` file to customize t
 .. autopydantic_settings:: rdagent.components.coder.factor_coder.config.FactorImplementSettings
     :settings-show-field-summary: False
     :members: coder_use_cache, data_folder, data_folder_debug, cache_location, enable_execution_cache, file_based_execution_timeout, select_method, select_threshold, max_loop, knowledge_base_path, new_knowledge_base_path
-    :exclude-members: Config, fail_task_trial_limit, v1_query_former_trace_limit, v1_query_similar_success_limit, v2_query_component_limit, v2_query_error_limit, v2_query_former_trace_limit, v2_error_summary, v2_knowledge_sampler
\ No newline at end of file
+    :exclude-members: Config, fail_task_trial_limit, v1_query_former_trace_limit, v1_query_similar_success_limit, v2_query_component_limit, v2_query_error_limit, v2_query_former_trace_limit, v2_error_summary, v2_knowledge_sampler
+    :no-index:
\ No newline at end of file
diff --git a/docs/scens/data_copilot_fin.rst b/docs/scens/data_copilot_fin.rst
index cc622135..6ea9e07d 100644
--- a/docs/scens/data_copilot_fin.rst
+++ b/docs/scens/data_copilot_fin.rst
@@ -138,4 +138,5 @@ The following environment variables can be set in the `.env` file to customize t
 .. autopydantic_settings:: rdagent.components.coder.factor_coder.config.FactorImplementSettings
     :settings-show-field-summary: False
     :members: coder_use_cache, data_folder, data_folder_debug, cache_location, enable_execution_cache, file_based_execution_timeout, select_method, select_threshold, max_loop, knowledge_base_path, new_knowledge_base_path
-    :exclude-members: Config, python_bin, fail_task_trial_limit, v1_query_former_trace_limit, v1_query_similar_success_limit, v2_query_component_limit, v2_query_error_limit, v2_query_former_trace_limit, v2_error_summary, v2_knowledge_sampler
\ No newline at end of file
+    :exclude-members: Config, python_bin, fail_task_trial_limit, v1_query_former_trace_limit, v1_query_similar_success_limit, v2_query_component_limit, v2_query_error_limit, v2_query_former_trace_limit, v2_error_summary, v2_knowledge_sampler
+    :no-index:
\ No newline at end of file
diff --git a/docs/ui.rst b/docs/ui.rst
index bc4ebf3e..0677c9ad 100644
--- a/docs/ui.rst
+++ b/docs/ui.rst
@@ -30,6 +30,7 @@ Use Web App
 1. Open the sidebar.
 
 .. TODO: update these
+
 2. Select the scenario you want to show. There are some pre-defined scenarios:
     - Qlib Model
     - Qlib Factor