Skip to content

Commit bddb97d

Browse files
TLSDCTLSDC
committed
adding readthedocs stuff
1 parent 67b205c commit bddb97d

File tree

11 files changed

+363
-0
lines changed

11 files changed

+363
-0
lines changed

‎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)

‎conf.py‎

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
# Configuration file for the Sphinx documentation builder.
2+
#
3+
# For the full list of built-in configuration values, see the documentation:
4+
# https://www.sphinx-doc.org/en/master/usage/configuration.html
5+
6+
# -- Project information -----------------------------------------------------
7+
# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
8+
9+
project = 'AgentLab'
10+
copyright = '2024, ServiceNow UI-Assist'
11+
author = 'ServiceNow UI-Assist'
12+
13+
# -- General configuration ---------------------------------------------------
14+
# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
15+
16+
extensions = []
17+
18+
templates_path = ['_templates']
19+
exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
20+
21+
22+
23+
# -- Options for HTML output -------------------------------------------------
24+
# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
25+
26+
html_theme = 'alabaster'
27+
html_static_path = ['_static']

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

Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
agentlab.agents.generic\_agent package
2+
======================================
3+
4+
Submodules
5+
----------
6+
7+
agentlab.agents.generic\_agent.agent\_configs module
8+
----------------------------------------------------
9+
10+
.. automodule:: agentlab.agents.generic_agent.agent_configs
11+
:members:
12+
:undoc-members:
13+
:show-inheritance:
14+
15+
agentlab.agents.generic\_agent.generic\_agent module
16+
----------------------------------------------------
17+
18+
.. automodule:: agentlab.agents.generic_agent.generic_agent
19+
:members:
20+
:undoc-members:
21+
:show-inheritance:
22+
23+
agentlab.agents.generic\_agent.generic\_agent\_prompt module
24+
------------------------------------------------------------
25+
26+
.. automodule:: agentlab.agents.generic_agent.generic_agent_prompt
27+
:members:
28+
:undoc-members:
29+
:show-inheritance:
30+
31+
agentlab.agents.generic\_agent.reproducibility\_agent module
32+
------------------------------------------------------------
33+
34+
.. automodule:: agentlab.agents.generic_agent.reproducibility_agent
35+
:members:
36+
:undoc-members:
37+
:show-inheritance:
38+
39+
agentlab.agents.generic\_agent.tmlr\_config module
40+
--------------------------------------------------
41+
42+
.. automodule:: agentlab.agents.generic_agent.tmlr_config
43+
:members:
44+
:undoc-members:
45+
: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: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
agentlab.agents package
2+
=======================
3+
4+
Subpackages
5+
-----------
6+
7+
.. toctree::
8+
:maxdepth: 4
9+
10+
agentlab.agents.generic_agent
11+
12+
Submodules
13+
----------
14+
15+
agentlab.agents.agent\_args module
16+
----------------------------------
17+
18+
.. automodule:: agentlab.agents.agent_args
19+
:members:
20+
:undoc-members:
21+
:show-inheritance:
22+
23+
agentlab.agents.dynamic\_prompting module
24+
-----------------------------------------
25+
26+
.. automodule:: agentlab.agents.dynamic_prompting
27+
:members:
28+
:undoc-members:
29+
: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: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
agentlab.analyze package
2+
========================
3+
4+
Submodules
5+
----------
6+
7+
agentlab.analyze.agent\_xray module
8+
-----------------------------------
9+
10+
.. automodule:: agentlab.analyze.agent_xray
11+
:members:
12+
:undoc-members:
13+
:show-inheritance:
14+
15+
agentlab.analyze.error\_categorization module
16+
---------------------------------------------
17+
18+
.. automodule:: agentlab.analyze.error_categorization
19+
:members:
20+
:undoc-members:
21+
:show-inheritance:
22+
23+
agentlab.analyze.inspect\_results module
24+
----------------------------------------
25+
26+
.. automodule:: agentlab.analyze.inspect_results
27+
:members:
28+
:undoc-members:
29+
:show-inheritance:
30+
31+
agentlab.analyze.plot\_tools module
32+
-----------------------------------
33+
34+
.. automodule:: agentlab.analyze.plot_tools
35+
:members:
36+
:undoc-members:
37+
:show-inheritance:
38+
39+
Module contents
40+
---------------
41+
42+
.. automodule:: agentlab.analyze
43+
:members:
44+
:undoc-members:
45+
:show-inheritance:

‎docs/source/agentlab.llm.rst‎

Lines changed: 69 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,69 @@
1+
agentlab.llm package
2+
====================
3+
4+
Submodules
5+
----------
6+
7+
agentlab.llm.base\_api module
8+
-----------------------------
9+
10+
.. automodule:: agentlab.llm.base_api
11+
:members:
12+
:undoc-members:
13+
:show-inheritance:
14+
15+
agentlab.llm.chat\_api module
16+
-----------------------------
17+
18+
.. automodule:: agentlab.llm.chat_api
19+
:members:
20+
:undoc-members:
21+
:show-inheritance:
22+
23+
agentlab.llm.huggingface\_utils module
24+
--------------------------------------
25+
26+
.. automodule:: agentlab.llm.huggingface_utils
27+
:members:
28+
:undoc-members:
29+
:show-inheritance:
30+
31+
agentlab.llm.llm\_configs module
32+
--------------------------------
33+
34+
.. automodule:: agentlab.llm.llm_configs
35+
:members:
36+
:undoc-members:
37+
:show-inheritance:
38+
39+
agentlab.llm.llm\_utils module
40+
------------------------------
41+
42+
.. automodule:: agentlab.llm.llm_utils
43+
:members:
44+
:undoc-members:
45+
:show-inheritance:
46+
47+
agentlab.llm.prompt\_templates module
48+
-------------------------------------
49+
50+
.. automodule:: agentlab.llm.prompt_templates
51+
:members:
52+
:undoc-members:
53+
:show-inheritance:
54+
55+
agentlab.llm.tracking module
56+
----------------------------
57+
58+
.. automodule:: agentlab.llm.tracking
59+
:members:
60+
:undoc-members:
61+
:show-inheritance:
62+
63+
Module contents
64+
---------------
65+
66+
.. automodule:: agentlab.llm
67+
:members:
68+
:undoc-members:
69+
:show-inheritance:

‎docs/source/agentlab.rst‎

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
agentlab package
2+
================
3+
4+
Subpackages
5+
-----------
6+
7+
.. toctree::
8+
:maxdepth: 4
9+
10+
agentlab.agents
11+
agentlab.analyze
12+
agentlab.llm
13+
agentlab.utils
14+
15+
Submodules
16+
----------
17+
18+
agentlab.ui\_assistant module
19+
-----------------------------
20+
21+
.. automodule:: agentlab.ui_assistant
22+
:members:
23+
:undoc-members:
24+
:show-inheritance:
25+
26+
Module contents
27+
---------------
28+
29+
.. automodule:: agentlab
30+
:members:
31+
:undoc-members:
32+
:show-inheritance:

‎docs/source/agentlab.utils.rst‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
agentlab.utils package
2+
======================
3+
4+
Submodules
5+
----------
6+
7+
agentlab.utils.bootstrap module
8+
-------------------------------
9+
10+
.. automodule:: agentlab.utils.bootstrap
11+
:members:
12+
:undoc-members:
13+
:show-inheritance:
14+
15+
Module contents
16+
---------------
17+
18+
.. automodule:: agentlab.utils
19+
:members:
20+
:undoc-members:
21+
:show-inheritance:

‎docs/source/modules.rst‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
src
2+
===
3+
4+
.. toctree::
5+
:maxdepth: 4
6+
7+
agentlab

‎index.rst‎

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
.. AgentLab documentation master file, created by
2+
sphinx-quickstart on Fri Nov 22 11:12:19 2024.
3+
You can adapt this file completely to your liking, but it should at least
4+
contain the root `toctree` directive.
5+
6+
AgentLab documentation
7+
======================
8+
9+
Add your content using ``reStructuredText`` syntax. See the
10+
`reStructuredText <https://www.sphinx-doc.org/en/master/usage/restructuredtext/index.html>`_
11+
documentation for details.
12+
13+
14+
.. toctree::
15+
:maxdepth: 2
16+
:caption: Contents:
17+

0 commit comments

Comments
 (0)