Merge pull request #991 from kristiankyvik/ensure-sphinx-correctly-parses-docstrings

Author: TheoMcCabe

.gitignore

@@ -62,16 +62,12 @@ projects/*
 # docs
 
 docs/_build
-docs/__init__
-docs/ai
-docs/chat_to_files
-docs/collect
-docs/learning
-docs/main
-docs/steps/
-docs/db
-docs/db/
-docs/core/
+docs/applications
+docs/benchmark
+docs/cli
+docs/core
+docs/intro
+docs/tools
 
 # coding assistants
 .aider*

.readthedocs.yaml

@@ -20,6 +20,8 @@ build:
       - poetry config virtualenvs.create false
     post_install:
       - poetry install
+    pre_build:
+      - python docs/create_api_rst.py
 
 # Build documentation in the "docs/" directory with Sphinx
 sphinx:

docs/api_reference.rst

@@ -4,10 +4,10 @@
 API Reference
 =============
 
-:mod:`gpt_engineer.cli`: Cli
-=============================
+:mod:`gpt_engineer.applications`: Applications
+===============================================
 
-.. automodule:: gpt_engineer.cli
+.. automodule:: gpt_engineer.applications
     :no-members:
     :no-inherited-members:
 
@@ -16,35 +16,61 @@ Classes
 .. currentmodule:: gpt_engineer
 
 .. autosummary::
-    :toctree: cli
+    :toctree: applications
     :template: class.rst
 
-    cli.file_selector.DisplayablePath
+    applications.cli.cli_agent.CliAgent
+    applications.cli.file_selector.DisplayablePath
 
 Functions
 --------------
 .. currentmodule:: gpt_engineer
 
 .. autosummary::
-    :toctree: cli
-
-    cli.collect.collect_learnings
-    cli.collect.send_learning
-    cli.collect.steps_file_hash
-    cli.file_selector.ask_for_files
-    cli.file_selector.gui_file_selector
-    cli.file_selector.is_in_ignoring_extensions
-    cli.file_selector.terminal_file_selector
-    cli.learning.ask_collection_consent
-    cli.learning.check_collection_consent
-    cli.learning.extract_learning
-    cli.learning.get_session
-    cli.learning.human_review_input
-    cli.learning.logs_to_string
-    cli.main.load_env_if_needed
-    cli.main.load_prompt
-    cli.main.main
-    cli.main.preprompts_path
+    :toctree: applications
+
+    applications.cli.collect.collect_and_send_human_review
+    applications.cli.collect.collect_learnings
+    applications.cli.collect.send_learning
+    applications.cli.learning.ask_collection_consent
+    applications.cli.learning.check_collection_consent
+    applications.cli.learning.extract_learning
+    applications.cli.learning.get_session
+    applications.cli.learning.human_review_input
+    applications.cli.main.get_preprompts_path
+    applications.cli.main.load_env_if_needed
+    applications.cli.main.load_prompt
+    applications.cli.main.main
+
+:mod:`gpt_engineer.benchmark`: Benchmark
+=========================================
+
+.. automodule:: gpt_engineer.benchmark
+    :no-members:
+    :no-inherited-members:
+
+Functions
+--------------
+.. currentmodule:: gpt_engineer
+
+.. autosummary::
+    :toctree: benchmark
+
+    benchmark.__main__.get_agent
+    benchmark.__main__.main
+    benchmark.benchmarks.gpteng.eval_tools.assert_exists_in_source_code
+    benchmark.benchmarks.gpteng.eval_tools.check_evaluation_component
+    benchmark.benchmarks.gpteng.eval_tools.check_language
+    benchmark.benchmarks.gpteng.eval_tools.run_code_class_has_property
+    benchmark.benchmarks.gpteng.eval_tools.run_code_class_has_property_w_value
+    benchmark.benchmarks.gpteng.eval_tools.run_code_eval_function
+    benchmark.benchmarks.gpteng.load.eval_to_task
+    benchmark.benchmarks.gpteng.load.expect_to_assertion
+    benchmark.benchmarks.gpteng.load.load_gpteng
+    benchmark.benchmarks.gptme.load.load_gptme
+    benchmark.benchmarks.load.get_benchmark
+    benchmark.run.print_results
+    benchmark.run.run
 
 :mod:`gpt_engineer.core`: Core
 ===============================
@@ -61,7 +87,13 @@ Classes
     :toctree: core
     :template: class.rst
 
-    core.steps.Config
+    core.base_agent.BaseAgent
+    core.base_execution_env.BaseExecutionEnv
+    core.default.disk_execution_env.DiskExecutionEnv
+    core.default.disk_memory.DiskMemory
+    core.default.simple_agent.SimpleAgent
+    core.files_dict.FilesDict
+    core.version_manager.BaseVersionManager
 
 Functions
 --------------
@@ -72,26 +104,48 @@ Functions
 
     core.ai.serialize_messages
     core.chat_to_files.apply_edits
-    core.chat_to_files.format_file_to_input
-    core.chat_to_files.get_code_strings
-    core.chat_to_files.overwrite_files_with_edits
-    core.chat_to_files.parse_chat
+    core.chat_to_files.chat_to_files_dict
+    core.chat_to_files.overwrite_code_with_edits
     core.chat_to_files.parse_edits
-    core.chat_to_files.to_files
-    core.chat_to_files.to_files_and_memory
-    core.db.archive
-    core.steps.assert_files_ready
-    core.steps.clarify
-    core.steps.curr_fn
-    core.steps.execute_entrypoint
-    core.steps.gen_clarified_code
-    core.steps.gen_entrypoint
-    core.steps.get_improve_prompt
-    core.steps.human_review
-    core.steps.improve_existing_code
-    core.steps.lite_gen
-    core.steps.set_improve_filelist
-    core.steps.setup_sys_prompt
-    core.steps.setup_sys_prompt_existing_code
-    core.steps.simple_gen
-    core.steps.use_feedback
+    core.default.paths.memory_path
+    core.default.paths.metadata_path
+    core.default.simple_agent.default_config_agent
+    core.default.steps.curr_fn
+    core.default.steps.execute_entrypoint
+    core.default.steps.gen_code
+    core.default.steps.gen_entrypoint
+    core.default.steps.improve
+    core.default.steps.incorrect_edit
+    core.default.steps.setup_sys_prompt
+    core.default.steps.setup_sys_prompt_existing_code
+
+:mod:`gpt_engineer.tools`: Tools
+=================================
+
+.. automodule:: gpt_engineer.tools
+    :no-members:
+    :no-inherited-members:
+
+Classes
+--------------
+.. currentmodule:: gpt_engineer
+
+.. autosummary::
+    :toctree: tools
+    :template: class.rst
+
+    tools.experimental.document_chunker.CodeSplitter
+    tools.experimental.document_chunker.SortedDocuments
+
+Functions
+--------------
+.. currentmodule:: gpt_engineer
+
+.. autosummary::
+    :toctree: tools
+
+    tools.custom_steps.clarified_gen
+    tools.custom_steps.get_platform_info
+    tools.custom_steps.lite_gen
+    tools.custom_steps.self_heal
+    tools.experimental.experimental_steps.improve_automatic_file_selection

docs/conf.py

@@ -65,7 +65,6 @@
     "sphinx.ext.napoleon",
     "sphinx.ext.viewcode",
     "sphinx_copybutton",
-    "sphinx_panels",
     "myst_parser",
     "IPython.sphinxext.ipython_console_highlighting",
 ]
@@ -86,6 +85,7 @@
 autodoc_member_order = "groupwise"
 autoclass_content = "both"
 autodoc_typehints_format = "short"
+autodoc_mock_imports = ["tree_sitter_languages", "llama-index"]
 
 autodoc_default_options = {
     "members": True,