diff --git a/docs/api.rst b/docs/api.rst index c4b7c59..ffd854a 100644 --- a/docs/api.rst +++ b/docs/api.rst @@ -1,7 +1,42 @@ API Reference ============ -.. automodule:: just_agents +Core +---- + +.. automodule:: just_agents.core + :members: + :undoc-members: + :show-inheritance: + +Tools +----- + +.. automodule:: just_agents.tools + :members: + :undoc-members: + :show-inheritance: + +Coding +------ + +.. automodule:: just_agents.coding + :members: + :undoc-members: + :show-inheritance: + +Web +--- + +.. automodule:: just_agents.web + :members: + :undoc-members: + :show-inheritance: + +Router +------ + +.. automodule:: just_agents.router :members: :undoc-members: :show-inheritance: \ No newline at end of file diff --git a/docs/conf.py b/docs/conf.py index 5cb3eb6..f3991b2 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -10,7 +10,8 @@ 'sphinx.ext.napoleon', 'sphinx.ext.viewcode', 'myst_parser', - 'sphinx.ext.intersphinx' + 'sphinx.ext.intersphinx', + 'sphinx_autodoc_typehints' ] # Add after the existing extensions @@ -45,4 +46,10 @@ # Intersphinx mapping intersphinx_mapping = { 'python': ('https://docs.python.org/3', None), -} \ No newline at end of file +} + +# Enable markdown parsing with MyST +myst_enable_extensions = [ + "colon_fence", + "deflist" +] \ No newline at end of file diff --git a/docs/index.rst b/docs/index.rst index ff7c6d6..dbf4df4 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -6,6 +6,7 @@ Welcome to just-agents documentation! :caption: Contents: readme + subprojects api examples diff --git a/docs/requirements.txt b/docs/requirements.txt index 290321b..0b80f18 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -1,4 +1,6 @@ sphinx>=7.0.0 sphinx-rtd-theme>=1.3.0 myst-parser>=2.0.0 -sphinx-autodoc-typehints>=1.25.2 \ No newline at end of file +sphinx-markdown-tables>=0.0.17 +sphinx-autodoc-typehints>=1.25.2 +sphinx-autoapi>=3.0.0 \ No newline at end of file diff --git a/docs/subprojects.rst b/docs/subprojects.rst new file mode 100644 index 0000000..12febc9 --- /dev/null +++ b/docs/subprojects.rst @@ -0,0 +1,32 @@ +Subprojects +=========== + +Core +---- +.. include:: ../core/README.md + :parser: myst_parser.sphinx_ + +Tools +----- +.. include:: ../tools/README.md + :parser: myst_parser.sphinx_ + +Coding +------ +.. include:: ../coding/README.md + :parser: myst_parser.sphinx_ + +Web +--- +.. include:: ../web/README.md + :parser: myst_parser.sphinx_ + +Router +------ +.. include:: ../router/README.md + :parser: myst_parser.sphinx_ + +Examples +-------- +.. include:: ../examples/README.md + :parser: myst_parser.sphinx_ \ No newline at end of file diff --git a/tests/test_chain_of_thought.py b/tests/test_chain_of_thought.py index 26d4eeb..25ee4fb 100644 --- a/tests/test_chain_of_thought.py +++ b/tests/test_chain_of_thought.py @@ -15,7 +15,7 @@ def count_letters(character: str, word: str) -> str: def test_function_query(): load_dotenv(override = True) - llm_options = just_agents.llm_options.OPENAI_O1_MINI + llm_options = just_agents.llm_options.OPENAI_GPT4oMINI agent: ChainOfThoughtAgent = ChainOfThoughtAgent(llm_options=llm_options, tools=[count_letters]) result, thoughts = agent.think("Count the number of occurrences of the letter 'L' in the word - 'LOLLAPALOOZA'.") print("Thoughts: ", thoughts)