Skip to content

Commit 6aea169

Browse files
committed
Update documentation
1 parent 42d339d commit 6aea169

31 files changed

+228
-140
lines changed

.buildinfo

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
# Sphinx build info version 1
22
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
3-
config: 6504529fc22095a1821ce59b9c36fde9
3+
config: 4cd82dbd7b3420fc9226beea123ec288
44
tags: 645f666f9bcd5a90fca523b33c5a78b7

_modules/index.html

Lines changed: 10 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -196,16 +196,16 @@
196196

197197
<span class="sidebar-brand-text">psyflow 0.1.1 documentation</span>
198198

199-
</a><div class="sidebar-cta entries-box">
200-
<ul style="list-style: none; padding-left: 0;">
201-
<li><a href="https://taskbeacon.github.io/">Taskbeacon Home</a></li>
202-
</ul>
203-
</div><form class="sidebar-search-container" method="get" action="../search.html" role="search">
199+
</a><form class="sidebar-search-container" method="get" action="../search.html" role="search">
204200
<input class="sidebar-search" placeholder="Search" name="q" aria-label="Search">
205201
<input type="hidden" name="check_keywords" value="yes">
206202
<input type="hidden" name="area" value="default">
207203
</form>
208-
<div id="searchbox"></div><div class="sidebar-tree">
204+
<div id="searchbox"></div><div class="sidebar-scroll"><div class="sidebar-cta entries-box">
205+
<ul style="list-style: none; padding-left: 0;">
206+
<li><a href="https://taskbeacon.github.io/">Taskbeacon Home</a></li>
207+
</ul>
208+
</div><div class="sidebar-tree">
209209
<p class="caption" role="heading"><span class="caption-text">Tutorials</span></p>
210210
<ul>
211211
<li class="toctree-l1"><a class="reference internal" href="../tutorials/getting_started.html">Getting Started with PsyFlow</a></li>
@@ -233,11 +233,14 @@
233233
</ul>
234234
<p class="caption" role="heading"><span class="caption-text">Indices and tables</span></p>
235235
<ul>
236+
<li class="toctree-l1 has-children"><a class="reference internal" href="../modules.html">API Reference</a><input class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" role="switch" type="checkbox"/><label for="toctree-checkbox-1"><div class="visually-hidden">Toggle navigation of API Reference</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul class="simple">
237+
</ul>
238+
</li>
236239
<li class="toctree-l1"><a class="reference internal" href="../genindex.html">Index</a></li>
237240
<li class="toctree-l1"><a class="reference internal" href="../py-modindex.html">Module Index</a></li>
238241
</ul>
239242

240-
</div>
243+
</div></div>
241244
</div>
242245

243246
</div>

_sources/index.rst.txt

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -19,8 +19,6 @@ Features
1919

2020
Start with one of the tutorials below or explore the API reference.
2121

22-
Tutorials
23-
---------
2422
.. toctree::
2523
:maxdepth: 1
2624
:caption: Tutorials
@@ -36,8 +34,8 @@ Tutorials
3634
tutorials/utilities
3735
tutorials/llm_client
3836

39-
中文教程(Chinese Tutorials)
40-
---------
37+
38+
4139
.. toctree::
4240
:maxdepth: 1
4341
:caption: 中文教程(Chinese Tutorials)
@@ -52,11 +50,11 @@ Tutorials
5250
tutorials/cli_usage_cn
5351
tutorials/llm_client_cn
5452

55-
Indices and tables
56-
---------
53+
5754
.. toctree::
5855
:maxdepth: 1
5956
:caption: Indices and tables
6057

58+
modules
6159
genindex
6260
modindex

api/modules.html

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -202,7 +202,7 @@
202202
<input type="hidden" name="check_keywords" value="yes">
203203
<input type="hidden" name="area" value="default">
204204
</form>
205-
<div id="searchbox"></div><div class="sidebar-cta entries-box">
205+
<div id="searchbox"></div><div class="sidebar-scroll"><div class="sidebar-cta entries-box">
206206
<ul style="list-style: none; padding-left: 0;">
207207
<li><a href="https://taskbeacon.github.io/">Taskbeacon Home</a></li>
208208
</ul>
@@ -234,11 +234,14 @@
234234
</ul>
235235
<p class="caption" role="heading"><span class="caption-text">Indices and tables</span></p>
236236
<ul>
237+
<li class="toctree-l1 has-children"><a class="reference internal" href="../modules.html">API Reference</a><input class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" role="switch" type="checkbox"/><label for="toctree-checkbox-1"><div class="visually-hidden">Toggle navigation of API Reference</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul class="simple">
238+
</ul>
239+
</li>
237240
<li class="toctree-l1"><a class="reference internal" href="../genindex.html">Index</a></li>
238241
<li class="toctree-l1"><a class="reference internal" href="../py-modindex.html">Module Index</a></li>
239242
</ul>
240243

241-
</div>
244+
</div></div>
242245
</div>
243246

244247
</div>

api/psyflow.html

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -202,7 +202,7 @@
202202
<input type="hidden" name="check_keywords" value="yes">
203203
<input type="hidden" name="area" value="default">
204204
</form>
205-
<div id="searchbox"></div><div class="sidebar-cta entries-box">
205+
<div id="searchbox"></div><div class="sidebar-scroll"><div class="sidebar-cta entries-box">
206206
<ul style="list-style: none; padding-left: 0;">
207207
<li><a href="https://taskbeacon.github.io/">Taskbeacon Home</a></li>
208208
</ul>
@@ -234,11 +234,14 @@
234234
</ul>
235235
<p class="caption" role="heading"><span class="caption-text">Indices and tables</span></p>
236236
<ul>
237+
<li class="toctree-l1 has-children"><a class="reference internal" href="../modules.html">API Reference</a><input class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" role="switch" type="checkbox"/><label for="toctree-checkbox-1"><div class="visually-hidden">Toggle navigation of API Reference</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul class="simple">
238+
</ul>
239+
</li>
237240
<li class="toctree-l1"><a class="reference internal" href="../genindex.html">Index</a></li>
238241
<li class="toctree-l1"><a class="reference internal" href="../py-modindex.html">Module Index</a></li>
239242
</ul>
240243

241-
</div>
244+
</div></div>
242245
</div>
243246

244247
</div>

genindex.html

Lines changed: 10 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -195,16 +195,16 @@
195195

196196
<span class="sidebar-brand-text">psyflow 0.1.1 documentation</span>
197197

198-
</a><div class="sidebar-cta entries-box">
199-
<ul style="list-style: none; padding-left: 0;">
200-
<li><a href="https://taskbeacon.github.io/">Taskbeacon Home</a></li>
201-
</ul>
202-
</div><form class="sidebar-search-container" method="get" action="search.html" role="search">
198+
</a><form class="sidebar-search-container" method="get" action="search.html" role="search">
203199
<input class="sidebar-search" placeholder="Search" name="q" aria-label="Search">
204200
<input type="hidden" name="check_keywords" value="yes">
205201
<input type="hidden" name="area" value="default">
206202
</form>
207-
<div id="searchbox"></div><div class="sidebar-tree">
203+
<div id="searchbox"></div><div class="sidebar-scroll"><div class="sidebar-cta entries-box">
204+
<ul style="list-style: none; padding-left: 0;">
205+
<li><a href="https://taskbeacon.github.io/">Taskbeacon Home</a></li>
206+
</ul>
207+
</div><div class="sidebar-tree">
208208
<p class="caption" role="heading"><span class="caption-text">Tutorials</span></p>
209209
<ul>
210210
<li class="toctree-l1"><a class="reference internal" href="tutorials/getting_started.html">Getting Started with PsyFlow</a></li>
@@ -232,11 +232,14 @@
232232
</ul>
233233
<p class="caption" role="heading"><span class="caption-text">Indices and tables</span></p>
234234
<ul class="current">
235+
<li class="toctree-l1 has-children"><a class="reference internal" href="modules.html">API Reference</a><input class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" role="switch" type="checkbox"/><label for="toctree-checkbox-1"><div class="visually-hidden">Toggle navigation of API Reference</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul class="simple">
236+
</ul>
237+
</li>
235238
<li class="toctree-l1 current current-page"><a class="current reference internal" href="#">Index</a></li>
236239
<li class="toctree-l1"><a class="reference internal" href="py-modindex.html">Module Index</a></li>
237240
</ul>
238241

239-
</div>
242+
</div></div>
240243
</div>
241244

242245
</div>

index.html

Lines changed: 14 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -197,16 +197,16 @@
197197

198198
<span class="sidebar-brand-text">psyflow 0.1.1 documentation</span>
199199

200-
</a><div class="sidebar-cta entries-box">
201-
<ul style="list-style: none; padding-left: 0;">
202-
<li><a href="https://taskbeacon.github.io/">Taskbeacon Home</a></li>
203-
</ul>
204-
</div><form class="sidebar-search-container" method="get" action="search.html" role="search">
200+
</a><form class="sidebar-search-container" method="get" action="search.html" role="search">
205201
<input class="sidebar-search" placeholder="Search" name="q" aria-label="Search">
206202
<input type="hidden" name="check_keywords" value="yes">
207203
<input type="hidden" name="area" value="default">
208204
</form>
209-
<div id="searchbox"></div><div class="sidebar-tree">
205+
<div id="searchbox"></div><div class="sidebar-scroll"><div class="sidebar-cta entries-box">
206+
<ul style="list-style: none; padding-left: 0;">
207+
<li><a href="https://taskbeacon.github.io/">Taskbeacon Home</a></li>
208+
</ul>
209+
</div><div class="sidebar-tree">
210210
<p class="caption" role="heading"><span class="caption-text">Tutorials</span></p>
211211
<ul>
212212
<li class="toctree-l1"><a class="reference internal" href="tutorials/getting_started.html">Getting Started with PsyFlow</a></li>
@@ -234,11 +234,14 @@
234234
</ul>
235235
<p class="caption" role="heading"><span class="caption-text">Indices and tables</span></p>
236236
<ul>
237+
<li class="toctree-l1 has-children"><a class="reference internal" href="modules.html">API Reference</a><input class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" role="switch" type="checkbox"/><label for="toctree-checkbox-1"><div class="visually-hidden">Toggle navigation of API Reference</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul class="simple">
238+
</ul>
239+
</li>
237240
<li class="toctree-l1"><a class="reference internal" href="genindex.html">Index</a></li>
238241
<li class="toctree-l1"><a class="reference internal" href="py-modindex.html">Module Index</a></li>
239242
</ul>
240243

241-
</div>
244+
</div></div>
242245
</div>
243246

244247
</div>
@@ -291,9 +294,6 @@ <h2>Features<a class="headerlink" href="#features" title="Link to this heading">
291294
<li><p>LLM integration and CLI scaffolding tools</p></li>
292295
</ul>
293296
<p>Start with one of the tutorials below or explore the API reference.</p>
294-
</section>
295-
<section id="tutorials">
296-
<h2>Tutorials<a class="headerlink" href="#tutorials" title="Link to this heading"></a></h2>
297297
<div class="toctree-wrapper compound">
298298
<p class="caption" role="heading"><span class="caption-text">Tutorials</span></p>
299299
<ul>
@@ -309,9 +309,6 @@ <h2>Tutorials<a class="headerlink" href="#tutorials" title="Link to this heading
309309
<li class="toctree-l1"><a class="reference internal" href="tutorials/llm_client.html">LLMClient: Using Large Language Models</a></li>
310310
</ul>
311311
</div>
312-
</section>
313-
<section id="chinese-tutorials">
314-
<h2>中文教程(Chinese Tutorials)<a class="headerlink" href="#chinese-tutorials" title="Link to this heading"></a></h2>
315312
<div class="toctree-wrapper compound">
316313
<p class="caption" role="heading"><span class="caption-text">中文教程(Chinese Tutorials)</span></p>
317314
<ul>
@@ -326,12 +323,10 @@ <h2>中文教程(Chinese Tutorials)<a class="headerlink" href="#chinese-tutorial
326323
<li class="toctree-l1"><a class="reference internal" href="tutorials/llm_client_cn.html">LLMClient: 使用大型语言模型</a></li>
327324
</ul>
328325
</div>
329-
</section>
330-
<section id="indices-and-tables">
331-
<h2>Indices and tables<a class="headerlink" href="#indices-and-tables" title="Link to this heading"></a></h2>
332326
<div class="toctree-wrapper compound">
333327
<p class="caption" role="heading"><span class="caption-text">Indices and tables</span></p>
334328
<ul>
329+
<li class="toctree-l1"><a class="reference internal" href="modules.html">API Reference</a></li>
335330
<li class="toctree-l1"><a class="reference internal" href="genindex.html">Index</a></li>
336331
<li class="toctree-l1"><a class="reference internal" href="py-modindex.html">Module Index</a></li>
337332
</ul>
@@ -385,10 +380,9 @@ <h2>Indices and tables<a class="headerlink" href="#indices-and-tables" title="Li
385380
<div class="toc-tree">
386381
<ul>
387382
<li><a class="reference internal" href="#">Welcome to psyflow</a><ul>
388-
<li><a class="reference internal" href="#features">Features</a></li>
389-
<li><a class="reference internal" href="#tutorials">Tutorials</a></li>
390-
<li><a class="reference internal" href="#chinese-tutorials">中文教程(Chinese Tutorials)</a></li>
391-
<li><a class="reference internal" href="#indices-and-tables">Indices and tables</a></li>
383+
<li><a class="reference internal" href="#features">Features</a><ul>
384+
</ul>
385+
</li>
392386
</ul>
393387
</li>
394388
</ul>

modules.html

Lines changed: 23 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
<head><meta charset="utf-8"/>
44
<meta name="viewport" content="width=device-width,initial-scale=1"/>
55
<meta name="color-scheme" content="light dark"><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />
6-
<link rel="index" title="Index" href="genindex.html" /><link rel="search" title="Search" href="search.html" />
6+
<link rel="index" title="Index" href="genindex.html" /><link rel="search" title="Search" href="search.html" /><link rel="prev" title="LLMClient: 使用大型语言模型" href="tutorials/llm_client_cn.html" />
77

88
<!-- Generated with Sphinx 7.3.7 and Furo 2024.08.06 -->
99
<title>API Reference - psyflow 0.1.1 documentation</title>
@@ -197,16 +197,16 @@
197197

198198
<span class="sidebar-brand-text">psyflow 0.1.1 documentation</span>
199199

200-
</a><div class="sidebar-cta entries-box">
201-
<ul style="list-style: none; padding-left: 0;">
202-
<li><a href="https://taskbeacon.github.io/">Taskbeacon Home</a></li>
203-
</ul>
204-
</div><form class="sidebar-search-container" method="get" action="search.html" role="search">
200+
</a><form class="sidebar-search-container" method="get" action="search.html" role="search">
205201
<input class="sidebar-search" placeholder="Search" name="q" aria-label="Search">
206202
<input type="hidden" name="check_keywords" value="yes">
207203
<input type="hidden" name="area" value="default">
208204
</form>
209-
<div id="searchbox"></div><div class="sidebar-tree">
205+
<div id="searchbox"></div><div class="sidebar-scroll"><div class="sidebar-cta entries-box">
206+
<ul style="list-style: none; padding-left: 0;">
207+
<li><a href="https://taskbeacon.github.io/">Taskbeacon Home</a></li>
208+
</ul>
209+
</div><div class="sidebar-tree">
210210
<p class="caption" role="heading"><span class="caption-text">Tutorials</span></p>
211211
<ul>
212212
<li class="toctree-l1"><a class="reference internal" href="tutorials/getting_started.html">Getting Started with PsyFlow</a></li>
@@ -233,12 +233,15 @@
233233
<li class="toctree-l1"><a class="reference internal" href="tutorials/llm_client_cn.html">LLMClient: 使用大型语言模型</a></li>
234234
</ul>
235235
<p class="caption" role="heading"><span class="caption-text">Indices and tables</span></p>
236-
<ul>
236+
<ul class="current">
237+
<li class="toctree-l1 current has-children current-page"><a class="current reference internal" href="#">API Reference</a><input checked="" class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" role="switch" type="checkbox"/><label for="toctree-checkbox-1"><div class="visually-hidden">Toggle navigation of API Reference</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul class="simple">
238+
</ul>
239+
</li>
237240
<li class="toctree-l1"><a class="reference internal" href="genindex.html">Index</a></li>
238241
<li class="toctree-l1"><a class="reference internal" href="py-modindex.html">Module Index</a></li>
239242
</ul>
240243

241-
</div>
244+
</div></div>
242245
</div>
243246

244247
</div>
@@ -290,7 +293,17 @@ <h1>API Reference<a class="headerlink" href="#api-reference" title="Link to this
290293

291294
<div class="related-pages">
292295

293-
296+
<a class="prev-page" href="tutorials/llm_client_cn.html">
297+
<svg class="furo-related-icon"><use href="#svg-arrow-right"></use></svg>
298+
<div class="page-info">
299+
<div class="context">
300+
<span>Previous</span>
301+
</div>
302+
303+
<div class="title">LLMClient: 使用大型语言模型</div>
304+
305+
</div>
306+
</a>
294307
</div>
295308
<div class="bottom-of-page">
296309
<div class="left-details">

objects.inv

-18 Bytes
Binary file not shown.

py-modindex.html

Lines changed: 10 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -195,16 +195,16 @@
195195

196196
<span class="sidebar-brand-text">psyflow 0.1.1 documentation</span>
197197

198-
</a><div class="sidebar-cta entries-box">
199-
<ul style="list-style: none; padding-left: 0;">
200-
<li><a href="https://taskbeacon.github.io/">Taskbeacon Home</a></li>
201-
</ul>
202-
</div><form class="sidebar-search-container" method="get" action="search.html" role="search">
198+
</a><form class="sidebar-search-container" method="get" action="search.html" role="search">
203199
<input class="sidebar-search" placeholder="Search" name="q" aria-label="Search">
204200
<input type="hidden" name="check_keywords" value="yes">
205201
<input type="hidden" name="area" value="default">
206202
</form>
207-
<div id="searchbox"></div><div class="sidebar-tree">
203+
<div id="searchbox"></div><div class="sidebar-scroll"><div class="sidebar-cta entries-box">
204+
<ul style="list-style: none; padding-left: 0;">
205+
<li><a href="https://taskbeacon.github.io/">Taskbeacon Home</a></li>
206+
</ul>
207+
</div><div class="sidebar-tree">
208208
<p class="caption" role="heading"><span class="caption-text">Tutorials</span></p>
209209
<ul>
210210
<li class="toctree-l1"><a class="reference internal" href="tutorials/getting_started.html">Getting Started with PsyFlow</a></li>
@@ -232,11 +232,14 @@
232232
</ul>
233233
<p class="caption" role="heading"><span class="caption-text">Indices and tables</span></p>
234234
<ul class="current">
235+
<li class="toctree-l1 has-children"><a class="reference internal" href="modules.html">API Reference</a><input class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" role="switch" type="checkbox"/><label for="toctree-checkbox-1"><div class="visually-hidden">Toggle navigation of API Reference</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul class="simple">
236+
</ul>
237+
</li>
235238
<li class="toctree-l1"><a class="reference internal" href="genindex.html">Index</a></li>
236239
<li class="toctree-l1 current current-page"><a class="current reference internal" href="#">Module Index</a></li>
237240
</ul>
238241

239-
</div>
242+
</div></div>
240243
</div>
241244

242245
</div>

0 commit comments

Comments
 (0)