Skip to content

Commit d6a44e3

Browse files
TLSDCTLSDC
committed
i have trust
1 parent 0b2ba57 commit d6a44e3

17 files changed

+236
-100
lines changed

‎.readthedocs.yaml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,4 +32,4 @@ sphinx:
3232
# See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
3333
python:
3434
install:
35-
- requirements: docs/requirements.txt
35+
- requirements: docs/source/requirements.txt

‎docs/requirements.txt‎

Lines changed: 0 additions & 3 deletions
This file was deleted.

‎docs/source/Makefile‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
# Minimal makefile for Sphinx documentation
2+
#
3+
4+
# You can set these variables from the command line, and also
5+
# from the environment for the first two.
6+
SPHINXOPTS ?=
7+
SPHINXBUILD ?= sphinx-build
8+
SOURCEDIR = .
9+
BUILDDIR = _build
10+
11+
# Put it first so that "make" without argument is like "make help".
12+
help:
13+
@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
14+
15+
.PHONY: help Makefile
16+
17+
# Catch-all target: route all unknown targets to Sphinx using the new
18+
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
19+
%: Makefile
20+
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

‎docs/source/_templates/module.rst.jinja‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
{%- if show_headings %}
2+
{{- [basename, "Module Documentation"] | join(' ') | e | heading(1) }}
3+
4+
**Module Overview**
5+
===================
6+
This is the documentation for the `{{ basename }}` module. Below you’ll find detailed descriptions of its functionality.
7+
8+
{% endif -%}
9+
.. automodule:: {{ qualname }}
10+
{%- for option in automodule_options %}
11+
:{{ option }}:
12+
{%- endfor %}
13+
14+
{%- if related_modules %}
15+
**Related Modules**
16+
===================
17+
The following modules are closely related and might be of interest:
18+
{%- for related in related_modules %}
19+
- {{ related }}
20+
{%- endfor %}
21+
{% endif %}

‎docs/source/_templates/package.rst.jinja‎

Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
{%- macro automodule(modname, options) -%}
2+
.. automodule:: {{ modname }}
3+
{%- for option in options %}
4+
:{{ option }}:
5+
{%- endfor %}
6+
{%- endmacro %}
7+
8+
{%- macro toctree(docnames) -%}
9+
.. toctree::
10+
:maxdepth: {{ maxdepth }}
11+
{% for docname in docnames %}
12+
{{ docname }}
13+
{%- endfor %}
14+
{%- endmacro %}
15+
16+
{%- if is_namespace %}
17+
{{- [pkgname, "NAMESPACE000"] | join(" ") | e | heading }}
18+
{% else %}
19+
{{- [pkgname, "PACKAGE000"] | join(" ") | e | heading }}
20+
{% endif %}
21+
22+
{%- if is_namespace %}
23+
.. py:module:: {{ pkgname }}
24+
{% endif %}
25+
26+
{%- if modulefirst and not is_namespace %}
27+
{{ automodule(pkgname, automodule_options) }}
28+
{% endif %}
29+
30+
{%- if subpackages %}
31+
SUBPACKAGES
32+
-----------
33+
34+
{{ toctree(subpackages) }}
35+
{% endif %}
36+
37+
{%- if submodules %}
38+
SUBMODULES
39+
----------
40+
{% if separatemodules %}
41+
{{ toctree(submodules) }}
42+
{% else %}
43+
{%- for submodule in submodules %}
44+
{% if show_headings %}
45+
{{- [submodule, "MODULE000"] | join(" ") | e | heading(2) }}
46+
{% endif %}
47+
{{ automodule(submodule, automodule_options) }}
48+
{% endfor %}
49+
{%- endif %}
50+
{%- endif %}
51+
52+
{%- if not modulefirst and not is_namespace %}
53+
MODULE CONTENTS
54+
---------------
55+
56+
{{ automodule(pkgname, automodule_options) }}
57+
{% endif %}

‎docs/source/_templates/toc.rst.jinja‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
{{ header | heading }}
2+
3+
.. toctree::
4+
:maxdepth: {{ maxdepth }}
5+
6+
{%- for docname in docnames %}
7+
{{ docname }}
8+
{%- endfor %}
9+
10+
**Table of Contents**
11+
======================
12+
This section provides an overview of the documentation structure. You can navigate to specific sections or modules using the links above.
13+
14+
{% for docname in docnames %}
15+
- [{{ docname }}](./{{ docname }}.html)
16+
{% endfor %}

‎docs/source/agentlab.agents.generic_agent.rst‎

Lines changed: 8 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,53 +1,40 @@
1-
agentlab.agents.generic\_agent package
2-
======================================
1+
agentlab.agents.generic\_agent PACKAGE000
2+
=========================================
33

4-
Submodules
4+
.. automodule:: agentlab.agents.generic_agent
5+
:members:
6+
:undoc-members:
7+
:show-inheritance:
8+
9+
SUBMODULES
510
----------
611

7-
agentlab.agents.generic\_agent.agent\_configs module
8-
----------------------------------------------------
912

1013
.. automodule:: agentlab.agents.generic_agent.agent_configs
1114
:members:
1215
:undoc-members:
1316
:show-inheritance:
1417

15-
agentlab.agents.generic\_agent.generic\_agent module
16-
----------------------------------------------------
1718

1819
.. automodule:: agentlab.agents.generic_agent.generic_agent
1920
:members:
2021
:undoc-members:
2122
:show-inheritance:
2223

23-
agentlab.agents.generic\_agent.generic\_agent\_prompt module
24-
------------------------------------------------------------
2524

2625
.. automodule:: agentlab.agents.generic_agent.generic_agent_prompt
2726
:members:
2827
:undoc-members:
2928
:show-inheritance:
3029

31-
agentlab.agents.generic\_agent.reproducibility\_agent module
32-
------------------------------------------------------------
3330

3431
.. automodule:: agentlab.agents.generic_agent.reproducibility_agent
3532
:members:
3633
:undoc-members:
3734
:show-inheritance:
3835

39-
agentlab.agents.generic\_agent.tmlr\_config module
40-
--------------------------------------------------
4136

4237
.. automodule:: agentlab.agents.generic_agent.tmlr_config
4338
:members:
4439
:undoc-members:
4540
:show-inheritance:
46-
47-
Module contents
48-
---------------
49-
50-
.. automodule:: agentlab.agents.generic_agent
51-
:members:
52-
:undoc-members:
53-
:show-inheritance:

‎docs/source/agentlab.agents.rst‎

Lines changed: 9 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,37 +1,30 @@
1-
agentlab.agents package
2-
=======================
1+
agentlab.agents PACKAGE000
2+
==========================
33

4-
Subpackages
4+
.. automodule:: agentlab.agents
5+
:members:
6+
:undoc-members:
7+
:show-inheritance:
8+
9+
SUBPACKAGES
510
-----------
611

712
.. toctree::
813
:maxdepth: 4
914

1015
agentlab.agents.generic_agent
1116

12-
Submodules
17+
SUBMODULES
1318
----------
1419

15-
agentlab.agents.agent\_args module
16-
----------------------------------
1720

1821
.. automodule:: agentlab.agents.agent_args
1922
:members:
2023
:undoc-members:
2124
:show-inheritance:
2225

23-
agentlab.agents.dynamic\_prompting module
24-
-----------------------------------------
2526

2627
.. automodule:: agentlab.agents.dynamic_prompting
2728
:members:
2829
:undoc-members:
2930
:show-inheritance:
30-
31-
Module contents
32-
---------------
33-
34-
.. automodule:: agentlab.agents
35-
:members:
36-
:undoc-members:
37-
:show-inheritance:

‎docs/source/agentlab.analyze.rst‎

Lines changed: 8 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,29 +1,22 @@
1-
agentlab.analyze package
2-
========================
1+
agentlab.analyze PACKAGE000
2+
===========================
33

4-
Submodules
5-
----------
6-
7-
agentlab.analyze.agent\_xray module
8-
-----------------------------------
9-
10-
.. automodule:: agentlab.analyze.agent_xray
4+
.. automodule:: agentlab.analyze
115
:members:
126
:undoc-members:
137
:show-inheritance:
148

15-
agentlab.analyze.inspect\_results module
16-
----------------------------------------
9+
SUBMODULES
10+
----------
1711

18-
.. automodule:: agentlab.analyze.inspect_results
12+
13+
.. automodule:: agentlab.analyze.agent_xray
1914
:members:
2015
:undoc-members:
2116
:show-inheritance:
2217

23-
Module contents
24-
---------------
2518

26-
.. automodule:: agentlab.analyze
19+
.. automodule:: agentlab.analyze.inspect_results
2720
:members:
2821
:undoc-members:
2922
:show-inheritance:

‎docs/source/agentlab.llm.rst‎

Lines changed: 8 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -1,69 +1,52 @@
1-
agentlab.llm package
2-
====================
1+
agentlab.llm PACKAGE000
2+
=======================
33

4-
Submodules
4+
.. automodule:: agentlab.llm
5+
:members:
6+
:undoc-members:
7+
:show-inheritance:
8+
9+
SUBMODULES
510
----------
611

7-
agentlab.llm.base\_api module
8-
-----------------------------
912

1013
.. automodule:: agentlab.llm.base_api
1114
:members:
1215
:undoc-members:
1316
:show-inheritance:
1417

15-
agentlab.llm.chat\_api module
16-
-----------------------------
1718

1819
.. automodule:: agentlab.llm.chat_api
1920
:members:
2021
:undoc-members:
2122
:show-inheritance:
2223

23-
agentlab.llm.huggingface\_utils module
24-
--------------------------------------
2524

2625
.. automodule:: agentlab.llm.huggingface_utils
2726
:members:
2827
:undoc-members:
2928
:show-inheritance:
3029

31-
agentlab.llm.llm\_configs module
32-
--------------------------------
3330

3431
.. automodule:: agentlab.llm.llm_configs
3532
:members:
3633
:undoc-members:
3734
:show-inheritance:
3835

39-
agentlab.llm.llm\_utils module
40-
------------------------------
4136

4237
.. automodule:: agentlab.llm.llm_utils
4338
:members:
4439
:undoc-members:
4540
:show-inheritance:
4641

47-
agentlab.llm.prompt\_templates module
48-
-------------------------------------
4942

5043
.. automodule:: agentlab.llm.prompt_templates
5144
:members:
5245
:undoc-members:
5346
:show-inheritance:
5447

55-
agentlab.llm.tracking module
56-
----------------------------
5748

5849
.. automodule:: agentlab.llm.tracking
5950
:members:
6051
:undoc-members:
6152
:show-inheritance:
62-
63-
Module contents
64-
---------------
65-
66-
.. automodule:: agentlab.llm
67-
:members:
68-
:undoc-members:
69-
:show-inheritance:

0 commit comments

Comments
 (0)