Skip to content

Commit 80b2fed

Browse files
committed
Update documentation
1 parent 500f508 commit 80b2fed

36 files changed

+7470
-3026
lines changed

_images/flowchart.png

102 KB
Loading

_modules/index.html

Lines changed: 46 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -204,16 +204,58 @@
204204
<div id="searchbox"></div><div class="sidebar-scroll"><div class="sidebar-tree">
205205
<p class="caption" role="heading"><span class="caption-text">Tutorials</span></p>
206206
<ul>
207-
<li class="toctree-l1"><a class="reference internal" href="../tutorials/getting_started.html">Getting Started with psyflow</a></li>
207+
<li class="toctree-l1"><a class="reference internal" href="../tutorials/getting_started.html">Getting Started with PsyFlow</a></li>
208208
<li class="toctree-l1"><a class="reference internal" href="../tutorials/get_subinfo.html">SubInfo: Collecting Participant Information</a></li>
209209
<li class="toctree-l1"><a class="reference internal" href="../tutorials/task_settings.html">TaskSettings: Configuring Your Experiment</a></li>
210210
<li class="toctree-l1"><a class="reference internal" href="../tutorials/build_blocks.html">BlockUnit: Managing Trials</a></li>
211211
<li class="toctree-l1"><a class="reference internal" href="../tutorials/build_stimulus.html">StimBank: Flexible Stimulus Management</a></li>
212212
<li class="toctree-l1"><a class="reference internal" href="../tutorials/build_stimunit.html">StimUnit: Modular Stimulus &amp; Response Handler</a></li>
213-
<li class="toctree-l1"><a class="reference internal" href="../tutorials/send_trigger.html">Sending Hardware Triggers</a></li>
214-
<li class="toctree-l1"><a class="reference internal" href="../tutorials/cli_usage.html">Command-Line Interface (CLI)</a></li>
213+
<li class="toctree-l1"><a class="reference internal" href="../tutorials/send_trigger.html">Overview</a></li>
214+
<li class="toctree-l1"><a class="reference internal" href="../tutorials/send_trigger.html#key-features">Key Features</a></li>
215+
<li class="toctree-l1"><a class="reference internal" href="../tutorials/send_trigger.html#quick-reference">Quick Reference</a></li>
216+
<li class="toctree-l1"><a class="reference internal" href="../tutorials/send_trigger.html#detailed-usage-guide">Detailed Usage Guide</a></li>
217+
<li class="toctree-l1"><a class="reference internal" href="../tutorials/send_trigger.html#integration-with-stimunit">5. Integration with <code class="docutils literal notranslate"><span class="pre">StimUnit</span></code></a></li>
218+
<li class="toctree-l1"><a class="reference internal" href="../tutorials/send_trigger.html#next-steps">Next Steps</a></li>
219+
<li class="toctree-l1"><a class="reference internal" href="../tutorials/cli_usage.html">Overview</a></li>
220+
<li class="toctree-l1"><a class="reference internal" href="../tutorials/cli_usage.html#quick-reference">Quick Reference</a></li>
221+
<li class="toctree-l1"><a class="reference internal" href="../tutorials/cli_usage.html#creating-a-new-project">1. Creating a New Project</a></li>
222+
<li class="toctree-l1"><a class="reference internal" href="../tutorials/cli_usage.html#inplace-initialization">2. In‑Place Initialization</a></li>
223+
<li class="toctree-l1"><a class="reference internal" href="../tutorials/cli_usage.html#how-it-works-internally">3. How It Works Internally</a></li>
224+
<li class="toctree-l1"><a class="reference internal" href="../tutorials/cli_usage.html#next-steps">Next Steps</a></li>
215225
<li class="toctree-l1"><a class="reference internal" href="../tutorials/utilities.html">Utility Functions</a></li>
216-
<li class="toctree-l1"><a class="reference internal" href="../tutorials/llm_client.html">Interacting with Large Language Models (LLMs)</a></li>
226+
<li class="toctree-l1"><a class="reference internal" href="../tutorials/llm_client.html">Overview</a></li>
227+
<li class="toctree-l1"><a class="reference internal" href="../tutorials/llm_client.html#supported-providers">Supported Providers</a></li>
228+
<li class="toctree-l1"><a class="reference internal" href="../tutorials/llm_client.html#key-features">Key Features</a></li>
229+
<li class="toctree-l1"><a class="reference internal" href="../tutorials/llm_client.html#quick-reference">Quick Reference</a></li>
230+
<li class="toctree-l1"><a class="reference internal" href="../tutorials/llm_client.html#detailed-usage-guide">Detailed Usage Guide</a></li>
231+
<li class="toctree-l1"><a class="reference internal" href="../tutorials/llm_client.html#next-steps">Next Steps</a></li>
232+
</ul>
233+
<p class="caption" role="heading"><span class="caption-text">中文教程(Chinese Tutorials)</span></p>
234+
<ul>
235+
<li class="toctree-l1"><a class="reference internal" href="../tutorials/getting_started_cn.html">PsyFlow 入门指南</a></li>
236+
<li class="toctree-l1"><a class="reference internal" href="../tutorials/get_subinfo_cn.html">SubInfo: 收集被试信息</a></li>
237+
<li class="toctree-l1"><a class="reference internal" href="../tutorials/task_settings_cn.html">TaskSettings: 管理实验配置</a></li>
238+
<li class="toctree-l1"><a class="reference internal" href="../tutorials/build_blocks_cn.html">BlockUnit: 组织和运行试验</a></li>
239+
<li class="toctree-l1"><a class="reference internal" href="../tutorials/build_stimulus_cn.html">StimBank:灵活的刺激管理</a></li>
240+
<li class="toctree-l1"><a class="reference internal" href="../tutorials/build_stimunit_cn.html">StimUnit:模块化的刺激呈现与反应处理单元</a></li>
241+
<li class="toctree-l1"><a class="reference internal" href="../tutorials/send_trigger_cn.html">概述</a></li>
242+
<li class="toctree-l1"><a class="reference internal" href="../tutorials/send_trigger_cn.html#id2">主要功能</a></li>
243+
<li class="toctree-l1"><a class="reference internal" href="../tutorials/send_trigger_cn.html#id3">快速参考</a></li>
244+
<li class="toctree-l1"><a class="reference internal" href="../tutorials/send_trigger_cn.html#id4">详细使用指南</a></li>
245+
<li class="toctree-l1"><a class="reference internal" href="../tutorials/send_trigger_cn.html#stimunit">5. 与 <code class="docutils literal notranslate"><span class="pre">StimUnit</span></code> 集成</a></li>
246+
<li class="toctree-l1"><a class="reference internal" href="../tutorials/send_trigger_cn.html#id8">后续步骤</a></li>
247+
<li class="toctree-l1"><a class="reference internal" href="../tutorials/cli_usage_cn.html">概述</a></li>
248+
<li class="toctree-l1"><a class="reference internal" href="../tutorials/cli_usage_cn.html#id2">快速参考</a></li>
249+
<li class="toctree-l1"><a class="reference internal" href="../tutorials/cli_usage_cn.html#id3">1. 创建一个新项目</a></li>
250+
<li class="toctree-l1"><a class="reference internal" href="../tutorials/cli_usage_cn.html#id4">2. 就地初始化</a></li>
251+
<li class="toctree-l1"><a class="reference internal" href="../tutorials/cli_usage_cn.html#id5">3. 内部工作原理</a></li>
252+
<li class="toctree-l1"><a class="reference internal" href="../tutorials/cli_usage_cn.html#id6">后续步骤</a></li>
253+
<li class="toctree-l1"><a class="reference internal" href="../tutorials/llm_client_cn.html">概述</a></li>
254+
<li class="toctree-l1"><a class="reference internal" href="../tutorials/llm_client_cn.html#id2">支持的提供商</a></li>
255+
<li class="toctree-l1"><a class="reference internal" href="../tutorials/llm_client_cn.html#id3">主要功能</a></li>
256+
<li class="toctree-l1"><a class="reference internal" href="../tutorials/llm_client_cn.html#id4">快速参考</a></li>
257+
<li class="toctree-l1"><a class="reference internal" href="../tutorials/llm_client_cn.html#id5">详细使用指南</a></li>
258+
<li class="toctree-l1"><a class="reference internal" href="../tutorials/llm_client_cn.html#id9">后续步骤</a></li>
217259
</ul>
218260

219261
</div>

0 commit comments

Comments
 (0)