Doc refactor (langchain-ai#6300)

Co-authored-by: jacoblee93 <[email protected]> Co-authored-by: Harrison Chase <[email protected]>
efriis · Jun 16, 2023 · 87e502c · 87e502c
1 parent 94c82a1
commit 87e502c
Show file tree

Hide file tree

Showing 1,027 changed files with 23,012 additions and 36,746 deletions.
diff --git a/.github/workflows/linkcheck.yml b/.github/workflows/linkcheck.yml
diff --git a/.gitignore b/.gitignore
@@ -73,6 +73,7 @@ instance/
 
 # Sphinx documentation
 docs/_build/
+docs/docs/_build/
 
 # PyBuilder
 target/
@@ -152,4 +153,15 @@ data_map*
 \[('_type', 'fake'), ('stop', None)]
 
 # Replit files
-*replit*
+*replit*
+
+node_modules
+docs/.yarn/
+docs/node_modules/
+docs/.docusaurus/
+docs/.cache-loader/
+docs/_dist
+docs/api_reference/_build
+docs/docs_skeleton/build
+docs/docs_skeleton/node_modules
+docs/docs_skeleton/yarn.lock
diff --git a/.gitmodules b/.gitmodules
@@ -0,0 +1,4 @@
+[submodule "docs/_docs_skeleton"]
+	path = docs/_docs_skeleton
+	url = https://github.com/langchain-ai/langchain-shared-docs
+	branch = main
diff --git a/.readthedocs.yaml b/.readthedocs.yaml
@@ -12,7 +12,7 @@ build:
 
 # Build documentation in the docs/ directory with Sphinx
 sphinx:
-   configuration: docs/conf.py
+   configuration: docs/api_reference/conf.py
 
 # If using Sphinx, optionally build your docs in additional formats such as PDF
 # formats:
@@ -23,4 +23,4 @@ python:
    install:
    - requirements: docs/requirements.txt
    - method: pip
-     path: .
+     path: .
diff --git a/Makefile b/Makefile
@@ -10,6 +10,9 @@ coverage:
 
 clean: docs_clean
 
+docs_compile:
+	poetry run nbdoc_build --srcdir $(srcdir)
+
 docs_build:
 	cd docs && poetry run make html
 

diff --git a/docs/Makefile → docs/api_reference/Makefile b/docs/Makefile → docs/api_reference/Makefile
diff --git a/docs/_static/css/custom.css → docs/api_reference/_static/css/custom.css b/docs/_static/css/custom.css → docs/api_reference/_static/css/custom.css
diff --git a/docs/_static/js/mendablesearch.js → ...pi_reference/_static/js/mendablesearch.js b/docs/_static/js/mendablesearch.js → ...pi_reference/_static/js/mendablesearch.js
diff --git a/docs/reference/agents.rst → docs/api_reference/agents.rst b/docs/reference/agents.rst → docs/api_reference/agents.rst
diff --git a/docs/conf.py → docs/api_reference/conf.py b/docs/conf.py → docs/api_reference/conf.py
@@ -17,7 +17,7 @@
 
 import toml
 
-with open("../pyproject.toml") as f:
+with open("../../pyproject.toml") as f:
     data = toml.load(f)
 
 # -- Project information -----------------------------------------------------
@@ -49,19 +49,31 @@
     "sphinx_copybutton",
     "sphinx_panels",
     "IPython.sphinxext.ipython_console_highlighting",
+    "sphinx_tabs.tabs",
 ]
-source_suffix = [".ipynb", ".html", ".md", ".rst"]
+source_suffix = [".rst"]
 
 autodoc_pydantic_model_show_json = False
 autodoc_pydantic_field_list_validators = False
 autodoc_pydantic_config_members = False
 autodoc_pydantic_model_show_config_summary = False
 autodoc_pydantic_model_show_validator_members = False
+autodoc_pydantic_model_show_validator_summary = False
 autodoc_pydantic_model_show_field_summary = False
 autodoc_pydantic_model_members = False
 autodoc_pydantic_model_undoc_members = False
-# autodoc_typehints = "signature"
-# autodoc_typehints = "description"
+autodoc_pydantic_model_hide_paramlist = False
+autodoc_pydantic_model_signature_prefix = "class"
+autodoc_pydantic_field_signature_prefix = "attribute"
+autodoc_pydantic_model_summary_list_order = "bysource"
+autodoc_member_order = "bysource"
+autodoc_default_options = {
+    "members": True,
+    "show-inheritance": True,
+    "undoc_members": True,
+    "inherited_members": "BaseModel",
+}
+autodoc_typehints = "description"
 
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ["_templates"]
@@ -77,20 +89,21 @@
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
 #
-html_theme = "sphinx_book_theme"
+html_theme = "sphinx_rtd_theme"
 
 html_theme_options = {
     "path_to_docs": "docs",
     "repository_url": "https://github.com/hwchase17/langchain",
     "use_repository_button": True,
+    # "style_nav_header_background": "white"
 }
 
 html_context = {
     "display_github": True,  # Integrate GitHub
     "github_user": "hwchase17",  # Username
     "github_repo": "langchain",  # Repo name
     "github_version": "master",  # Version
-    "conf_py_path": "/docs/",  # Path in the checkout to the docs root
+    "conf_py_path": "/docs/api_reference",  # Path in the checkout to the docs root
 }
 
 # Add any paths that contain custom static files (such as style sheets) here,

diff --git a/docs/reference/indexes.rst → docs/api_reference/data_connection.rst b/docs/reference/indexes.rst → docs/api_reference/data_connection.rst
@@ -1,16 +1,13 @@
-Indexes
+Data connection
 ==============
-Indexes refer to ways to structure documents so that LLMs can best interact with them.
 LangChain has a number of modules that help you load, structure, store, and retrieve documents.
 
 .. toctree::
    :maxdepth: 1
    :glob:
 
-   modules/docstore
-   modules/text_splitter
    modules/document_loaders
+   modules/document_transformers
+   modules/embeddings
    modules/vectorstores
    modules/retrievers
-   modules/document_compressors
-   modules/document_transformers
diff --git a/docs/api_reference/index.rst b/docs/api_reference/index.rst
@@ -0,0 +1,29 @@
+API Reference
+==========================
+
+| Full documentation on all methods, classes, and APIs in the LangChain Python package.
+
+.. toctree::
+   :maxdepth: 1
+   :caption: Abstractions
+
+   ./modules/base_classes.rst
+
+
+.. toctree::
+   :maxdepth: 1
+   :caption: Core
+
+   ./model_io.rst
+   ./data_connection.rst
+   ./modules/chains.rst
+   ./agents.rst
+   ./modules/memory.rst
+   ./modules/callbacks.rst
+
+.. toctree::
+   :maxdepth: 1
+   :caption: Additional
+
+   ./modules/utilities.rst
+   ./modules/experimental.rst
diff --git a/docs/make.bat → docs/api_reference/make.bat b/docs/make.bat → docs/api_reference/make.bat
diff --git a/docs/api_reference/model_io.rst b/docs/api_reference/model_io.rst
@@ -0,0 +1,12 @@
+Model I/O
+==============
+
+LangChain provides interfaces and integrations for working with language models.
+
+.. toctree::
+   :maxdepth: 1
+   :glob:
+
+   ./prompts.rst
+   ./models.rst
+   ./modules/output_parsers.rst
diff --git a/docs/reference/models.rst → docs/api_reference/models.rst b/docs/reference/models.rst → docs/api_reference/models.rst
@@ -9,4 +9,3 @@ LangChain provides interfaces and integrations for a number of different types o
 
    modules/llms
    modules/chat_models
-   modules/embeddings
diff --git a/docs/reference/modules/agent_toolkits.rst → .../api_reference/modules/agent_toolkits.rst b/docs/reference/modules/agent_toolkits.rst → .../api_reference/modules/agent_toolkits.rst
diff --git a/docs/reference/modules/agents.rst → docs/api_reference/modules/agents.rst b/docs/reference/modules/agents.rst → docs/api_reference/modules/agents.rst
diff --git a/docs/api_reference/modules/base_classes.rst b/docs/api_reference/modules/base_classes.rst
@@ -0,0 +1,5 @@
+Base classes
+========================
+
+.. automodule:: langchain.schema
+   :inherited-members:
diff --git a/docs/api_reference/modules/callbacks.rst b/docs/api_reference/modules/callbacks.rst
@@ -0,0 +1,7 @@
+Callbacks
+=======================
+
+.. automodule:: langchain.callbacks
+   :members:
+   :undoc-members:
+
diff --git a/docs/reference/modules/chains.rst → docs/api_reference/modules/chains.rst b/docs/reference/modules/chains.rst → docs/api_reference/modules/chains.rst
@@ -4,4 +4,5 @@ Chains
 .. automodule:: langchain.chains
    :members:
    :undoc-members:
+   :inherited-members: BaseModel
 
diff --git a/docs/reference/modules/chat_models.rst → docs/api_reference/modules/chat_models.rst b/docs/reference/modules/chat_models.rst → docs/api_reference/modules/chat_models.rst
diff --git a/docs/reference/modules/document_loaders.rst → ...pi_reference/modules/document_loaders.rst b/docs/reference/modules/document_loaders.rst → ...pi_reference/modules/document_loaders.rst
diff --git a/...ference/modules/document_transformers.rst → ...ference/modules/document_transformers.rst b/...ference/modules/document_transformers.rst → ...ference/modules/document_transformers.rst
@@ -5,3 +5,9 @@ Document Transformers
    :members:
    :undoc-members:
 
+Text Splitters
+------------------------------
+
+.. automodule:: langchain.text_splitter
+   :members:
+   :undoc-members:
diff --git a/docs/reference/modules/embeddings.rst → docs/api_reference/modules/embeddings.rst b/docs/reference/modules/embeddings.rst → docs/api_reference/modules/embeddings.rst
diff --git a/docs/reference/modules/example_selector.rst → ...pi_reference/modules/example_selector.rst b/docs/reference/modules/example_selector.rst → ...pi_reference/modules/example_selector.rst
diff --git a/docs/reference/modules/experimental.rst → docs/api_reference/modules/experimental.rst b/docs/reference/modules/experimental.rst → docs/api_reference/modules/experimental.rst
@@ -1,10 +1,10 @@
 ====================
-Experimental Modules
+Experimental
 ====================
 
 This module contains experimental modules and reproductions of existing work using LangChain primitives.
 
-Autonomous Agents
+Autonomous agents
 ------------------
 
 Here, we document the BabyAGI and AutoGPT classes from the langchain.experimental module.
@@ -16,7 +16,7 @@ Here, we document the BabyAGI and AutoGPT classes from the langchain.experimenta
    :members:
 
 
-Generative Agents
+Generative agents
 ------------------
 
 Here, we document the GenerativeAgent and GenerativeAgentMemory classes from the langchain.experimental module.

diff --git a/docs/reference/modules/llms.rst → docs/api_reference/modules/llms.rst b/docs/reference/modules/llms.rst → docs/api_reference/modules/llms.rst
diff --git a/docs/reference/modules/memory.rst → docs/api_reference/modules/memory.rst b/docs/reference/modules/memory.rst → docs/api_reference/modules/memory.rst
diff --git a/docs/reference/modules/output_parsers.rst → .../api_reference/modules/output_parsers.rst b/docs/reference/modules/output_parsers.rst → .../api_reference/modules/output_parsers.rst
diff --git a/docs/reference/modules/prompts.rst → docs/api_reference/modules/prompts.rst b/docs/reference/modules/prompts.rst → docs/api_reference/modules/prompts.rst
@@ -1,5 +1,6 @@
-PromptTemplates
+Prompt Templates
 ========================
 
 .. automodule:: langchain.prompts
    :members:
+   :undoc-members:
diff --git a/docs/api_reference/modules/retrievers.rst b/docs/api_reference/modules/retrievers.rst
@@ -0,0 +1,14 @@
+Retrievers
+===============================
+
+.. automodule:: langchain.retrievers
+   :members:
+   :undoc-members:
+
+Document compressors
+-------------------------------
+
+.. automodule:: langchain.retrievers.document_compressors
+   :members:
+   :undoc-members:
+
diff --git a/docs/reference/modules/tools.rst → docs/api_reference/modules/tools.rst b/docs/reference/modules/tools.rst → docs/api_reference/modules/tools.rst
diff --git a/docs/reference/modules/utilities.rst → docs/api_reference/modules/utilities.rst b/docs/reference/modules/utilities.rst → docs/api_reference/modules/utilities.rst
diff --git a/docs/reference/modules/vectorstores.rst → docs/api_reference/modules/vectorstores.rst b/docs/reference/modules/vectorstores.rst → docs/api_reference/modules/vectorstores.rst
diff --git a/docs/reference/prompts.rst → docs/api_reference/prompts.rst b/docs/reference/prompts.rst → docs/api_reference/prompts.rst
@@ -9,4 +9,3 @@ The reference guides here all relate to objects for working with Prompts.
 
    modules/prompts
    modules/example_selector
-   modules/output_parsers
Original file line number	Diff line number	Diff line change
Expand Up		@@ -9,4 +9,3 @@ LangChain provides interfaces and integrations for a number of different types o

		modules/llms
		modules/chat_models
		modules/embeddings
Original file line number	Diff line number	Diff line change
Expand Up		@@ -9,4 +9,3 @@ The reference guides here all relate to objects for working with Prompts.

		modules/prompts
		modules/example_selector
		modules/output_parsers