Merge pull request #13 from ShoggothAI/add_readthedocs

Add readthedocs

.readthedocs.yaml

@@ -13,10 +13,18 @@ build:
     # nodejs: "19"
     # rust: "1.64"
     # golang: "1.19"
+  jobs:
+    post_create_environment:
+      # Install poetry
+      # https://python-poetry.org/docs/#installing-manually
+      - python -m pip install poetry
+    post_install:
+      # Install dependencies with 'docs' dependency group
+      - VIRTUAL_ENV=$READTHEDOCS_VIRTUALENV_PATH poetry install
 
 # Build documentation in the "docs/" directory with Sphinx
 sphinx:
-  configuration: docs/conf.py
+  configuration: docs/source/conf.py
 
 # Optionally build your docs in additional formats such as PDF and ePub
 # formats:
@@ -26,6 +34,6 @@ sphinx:
 # Optional but recommended, declare the Python requirements required
 # to build your documentation
 # See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
-# python:
-#    install:
-#    - requirements: docs/requirements.txt
+#python:
+#  install:
+#  - requirements: docs/requirements.txt

docs/Makefile

@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS    ?=
+SPHINXBUILD   ?= sphinx-build
+SOURCEDIR     = source
+BUILDDIR      = build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

docs/make.bat

@@ -0,0 +1,35 @@
+@ECHO OFF
+
+pushd %~dp0
+
+REM Command file for Sphinx documentation
+
+if "%SPHINXBUILD%" == "" (
+	set SPHINXBUILD=sphinx-build
+)
+set SOURCEDIR=source
+set BUILDDIR=build
+
+%SPHINXBUILD% >NUL 2>NUL
+if errorlevel 9009 (
+	echo.
+	echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
+	echo.installed, then set the SPHINXBUILD environment variable to point
+	echo.to the full path of the 'sphinx-build' executable. Alternatively you
+	echo.may add the Sphinx directory to PATH.
+	echo.
+	echo.If you don't have Sphinx installed, grab it from
+	echo.https://www.sphinx-doc.org/
+	exit /b 1
+)
+
+if "%1" == "" goto help
+
+%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+goto end
+
+:help
+%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+
+:end
+popd

docs/source/_autosummary/motleycrew.agent.crewai.crewai.CrewAIAgentWithConfig.rst

@@ -0,0 +1,80 @@
+motleycrew.agent.crewai.crewai.CrewAIAgentWithConfig
+====================================================
+
+.. currentmodule:: motleycrew.agent.crewai.crewai
+
+.. autoclass:: CrewAIAgentWithConfig
+
+
+
+   .. rubric:: Methods
+
+   .. autosummary::
+
+   .. automethod:: CrewAIAgentWithConfig.__init__
+   .. automethod:: CrewAIAgentWithConfig.construct
+   .. automethod:: CrewAIAgentWithConfig.copy
+   .. automethod:: CrewAIAgentWithConfig.create_agent_executor
+   .. automethod:: CrewAIAgentWithConfig.dict
+   .. automethod:: CrewAIAgentWithConfig.execute_task
+   .. automethod:: CrewAIAgentWithConfig.format_log_to_str
+   .. automethod:: CrewAIAgentWithConfig.from_orm
+   .. automethod:: CrewAIAgentWithConfig.increment_formatting_errors
+   .. automethod:: CrewAIAgentWithConfig.interpolate_inputs
+   .. automethod:: CrewAIAgentWithConfig.json
+   .. automethod:: CrewAIAgentWithConfig.model_construct
+   .. automethod:: CrewAIAgentWithConfig.model_copy
+   .. automethod:: CrewAIAgentWithConfig.model_dump
+   .. automethod:: CrewAIAgentWithConfig.model_dump_json
+   .. automethod:: CrewAIAgentWithConfig.model_json_schema
+   .. automethod:: CrewAIAgentWithConfig.model_parametrized_name
+   .. automethod:: CrewAIAgentWithConfig.model_post_init
+   .. automethod:: CrewAIAgentWithConfig.model_rebuild
+   .. automethod:: CrewAIAgentWithConfig.model_validate
+   .. automethod:: CrewAIAgentWithConfig.model_validate_json
+   .. automethod:: CrewAIAgentWithConfig.model_validate_strings
+   .. automethod:: CrewAIAgentWithConfig.parse_file
+   .. automethod:: CrewAIAgentWithConfig.parse_obj
+   .. automethod:: CrewAIAgentWithConfig.parse_raw
+   .. automethod:: CrewAIAgentWithConfig.schema
+   .. automethod:: CrewAIAgentWithConfig.schema_json
+   .. automethod:: CrewAIAgentWithConfig.set_agent_executor
+   .. automethod:: CrewAIAgentWithConfig.set_cache_handler
+   .. automethod:: CrewAIAgentWithConfig.set_private_attrs
+   .. automethod:: CrewAIAgentWithConfig.set_rpm_controller
+   .. automethod:: CrewAIAgentWithConfig.update_forward_refs
+   .. automethod:: CrewAIAgentWithConfig.validate
+
+
+
+
+
+   .. rubric:: Attributes
+
+   .. autosummary::
+
+   .. autoattribute:: CrewAIAgentWithConfig.model_computed_fields
+   .. autoattribute:: CrewAIAgentWithConfig.model_config
+   .. autoattribute:: CrewAIAgentWithConfig.model_extra
+   .. autoattribute:: CrewAIAgentWithConfig.model_fields
+   .. autoattribute:: CrewAIAgentWithConfig.model_fields_set
+   .. autoattribute:: CrewAIAgentWithConfig.formatting_errors
+   .. autoattribute:: CrewAIAgentWithConfig.id
+   .. autoattribute:: CrewAIAgentWithConfig.role
+   .. autoattribute:: CrewAIAgentWithConfig.goal
+   .. autoattribute:: CrewAIAgentWithConfig.backstory
+   .. autoattribute:: CrewAIAgentWithConfig.max_rpm
+   .. autoattribute:: CrewAIAgentWithConfig.memory
+   .. autoattribute:: CrewAIAgentWithConfig.verbose
+   .. autoattribute:: CrewAIAgentWithConfig.allow_delegation
+   .. autoattribute:: CrewAIAgentWithConfig.tools
+   .. autoattribute:: CrewAIAgentWithConfig.max_iter
+   .. autoattribute:: CrewAIAgentWithConfig.agent_executor
+   .. autoattribute:: CrewAIAgentWithConfig.tools_handler
+   .. autoattribute:: CrewAIAgentWithConfig.cache_handler
+   .. autoattribute:: CrewAIAgentWithConfig.step_callback
+   .. autoattribute:: CrewAIAgentWithConfig.i18n
+   .. autoattribute:: CrewAIAgentWithConfig.llm
+   .. autoattribute:: CrewAIAgentWithConfig.function_calling_llm
+
+

docs/source/_autosummary/motleycrew.agent.crewai.crewai.CrewAIMotleyAgentParent.rst

@@ -0,0 +1,36 @@
+motleycrew.agent.crewai.crewai.CrewAIMotleyAgentParent
+======================================================
+
+.. currentmodule:: motleycrew.agent.crewai.crewai
+
+.. autoclass:: CrewAIMotleyAgentParent
+
+
+
+   .. rubric:: Methods
+
+   .. autosummary::
+
+   .. automethod:: CrewAIMotleyAgentParent.__init__
+   .. automethod:: CrewAIMotleyAgentParent.add_tools
+   .. automethod:: CrewAIMotleyAgentParent.as_tool
+   .. automethod:: CrewAIMotleyAgentParent.call_as_tool
+   .. automethod:: CrewAIMotleyAgentParent.from_agent
+   .. automethod:: CrewAIMotleyAgentParent.from_crewai_params
+   .. automethod:: CrewAIMotleyAgentParent.invoke
+   .. automethod:: CrewAIMotleyAgentParent.materialize
+   .. automethod:: CrewAIMotleyAgentParent.set_cache_handler
+   .. automethod:: CrewAIMotleyAgentParent.set_rpm_controller
+
+
+
+
+
+   .. rubric:: Attributes
+
+   .. autosummary::
+
+   .. autoattribute:: CrewAIMotleyAgentParent.agent
+   .. autoattribute:: CrewAIMotleyAgentParent.is_materialized
+
+

docs/source/_autosummary/motleycrew.agent.crewai.crewai.rst

@@ -0,0 +1,36 @@
+motleycrew.agent.crewai.crewai
+==============================
+
+.. automodule:: motleycrew.agent.crewai.crewai
+
+
+
+
+
+
+
+
+
+
+
+   .. rubric:: Classes
+
+   .. autosummary::
+     :toctree:
+
+     CrewAIAgentWithConfig
+     CrewAIMotleyAgentParent
+
+   .. autoclass:: CrewAIAgentWithConfig
+     :members:
+   .. autoclass:: CrewAIMotleyAgentParent
+     :members:
+
+
+
+
+
+
+
+
+

docs/source/_autosummary/motleycrew.agent.crewai.crewai_agent.CrewAIMotleyAgent.rst

@@ -0,0 +1,36 @@
+motleycrew.agent.crewai.crewai\_agent.CrewAIMotleyAgent
+=======================================================
+
+.. currentmodule:: motleycrew.agent.crewai.crewai_agent
+
+.. autoclass:: CrewAIMotleyAgent
+
+
+
+   .. rubric:: Methods
+
+   .. autosummary::
+
+   .. automethod:: CrewAIMotleyAgent.__init__
+   .. automethod:: CrewAIMotleyAgent.add_tools
+   .. automethod:: CrewAIMotleyAgent.as_tool
+   .. automethod:: CrewAIMotleyAgent.call_as_tool
+   .. automethod:: CrewAIMotleyAgent.from_agent
+   .. automethod:: CrewAIMotleyAgent.from_crewai_params
+   .. automethod:: CrewAIMotleyAgent.invoke
+   .. automethod:: CrewAIMotleyAgent.materialize
+   .. automethod:: CrewAIMotleyAgent.set_cache_handler
+   .. automethod:: CrewAIMotleyAgent.set_rpm_controller
+
+
+
+
+
+   .. rubric:: Attributes
+
+   .. autosummary::
+
+   .. autoattribute:: CrewAIMotleyAgent.agent
+   .. autoattribute:: CrewAIMotleyAgent.is_materialized
+
+

docs/source/_autosummary/motleycrew.agent.crewai.crewai_agent.rst

@@ -0,0 +1,33 @@
+motleycrew.agent.crewai.crewai\_agent
+=====================================
+
+.. automodule:: motleycrew.agent.crewai.crewai_agent
+
+
+
+
+
+
+
+
+
+
+
+   .. rubric:: Classes
+
+   .. autosummary::
+     :toctree:
+
+     CrewAIMotleyAgent
+
+   .. autoclass:: CrewAIMotleyAgent
+     :members:
+
+
+
+
+
+
+
+
+

docs/source/_autosummary/motleycrew.agent.crewai.rst

@@ -0,0 +1,32 @@
+motleycrew.agent.crewai
+=======================
+
+.. automodule:: motleycrew.agent.crewai
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+.. rubric:: Modules
+
+.. autosummary::
+   :toctree:
+   :recursive:
+
+   motleycrew.agent.crewai.crewai
+   motleycrew.agent.crewai.crewai_agent
+

docs/source/_autosummary/motleycrew.agent.langchain.langchain.LangchainMotleyAgentParent.rst

@@ -0,0 +1,34 @@
+motleycrew.agent.langchain.langchain.LangchainMotleyAgentParent
+===============================================================
+
+.. currentmodule:: motleycrew.agent.langchain.langchain
+
+.. autoclass:: LangchainMotleyAgentParent
+
+
+
+   .. rubric:: Methods
+
+   .. autosummary::
+
+   .. automethod:: LangchainMotleyAgentParent.__init__
+   .. automethod:: LangchainMotleyAgentParent.add_tools
+   .. automethod:: LangchainMotleyAgentParent.as_tool
+   .. automethod:: LangchainMotleyAgentParent.call_as_tool
+   .. automethod:: LangchainMotleyAgentParent.from_agent
+   .. automethod:: LangchainMotleyAgentParent.from_function
+   .. automethod:: LangchainMotleyAgentParent.invoke
+   .. automethod:: LangchainMotleyAgentParent.materialize
+
+
+
+
+
+   .. rubric:: Attributes
+
+   .. autosummary::
+
+   .. autoattribute:: LangchainMotleyAgentParent.agent
+   .. autoattribute:: LangchainMotleyAgentParent.is_materialized
+
+