Skip to content

Commit 4a93329

Browse files
authored
fix_docs_warning (#195)
1 parent 4638e62 commit 4a93329

File tree

4 files changed

+6
-3
lines changed

4 files changed

+6
-3
lines changed

Makefile

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -189,7 +189,7 @@ release-notes:
189189

190190
# Build documentation only from rdagent.
191191
docs-gen:
192-
$(PIPRUN) python -m sphinx.cmd.build docs $(PUBLIC_DIR)
192+
$(PIPRUN) python -m sphinx.cmd.build -W docs $(PUBLIC_DIR)
193193

194194
# Generate mypy reports.
195195
docs-mypy: docs-gen

docs/scens/data_agent_fin.rst

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -125,4 +125,5 @@ The following environment variables can be set in the `.env` file to customize t
125125
.. autopydantic_settings:: rdagent.components.coder.factor_coder.config.FactorImplementSettings
126126
:settings-show-field-summary: False
127127
: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
128-
: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
128+
: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
129+
:no-index:

docs/scens/data_copilot_fin.rst

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -138,4 +138,5 @@ The following environment variables can be set in the `.env` file to customize t
138138
.. autopydantic_settings:: rdagent.components.coder.factor_coder.config.FactorImplementSettings
139139
:settings-show-field-summary: False
140140
: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
141-
: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
141+
: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
142+
:no-index:

docs/ui.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,7 @@ Use Web App
3030
1. Open the sidebar.
3131

3232
.. TODO: update these
33+
3334
2. Select the scenario you want to show. There are some pre-defined scenarios:
3435
- Qlib Model
3536
- Qlib Factor

0 commit comments

Comments
 (0)