From d9039ae3b28628abcf315205df1ef9e38cd90be6 Mon Sep 17 00:00:00 2001
From: Laurie Voss <github@seldo.com>
Date: Wed, 22 Nov 2023 09:30:24 -0800
Subject: [PATCH] Multiple fixes to make various API reference docs visible to
Algolia (#9065)
---
docs/Makefile | 2 +-
docs/api_reference/index.rst | 27 +++++++++----------
docs/api_reference/node.rst | 6 ++---
docs/api_reference/readers.rst | 5 ++--
.../service_context/node_parser.rst | 5 ++--
docs/api_reference/storage/vector_store.rst | 5 ++--
docs/conf.py | 4 +++
docs/requirements.txt | 1 +
llama_index/vector_stores/__init__.py | 1 +
9 files changed, 28 insertions(+), 28 deletions(-)
diff --git a/docs/Makefile b/docs/Makefile
index d4bb2cbb9e..8241a9397e 100644
--- a/docs/Makefile
+++ b/docs/Makefile
@@ -17,4 +17,4 @@ help:
# 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)
+ @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) -j 8
diff --git a/docs/api_reference/index.rst b/docs/api_reference/index.rst
index cae783923d..b5be4ee8b0 100644
--- a/docs/api_reference/index.rst
+++ b/docs/api_reference/index.rst
@@ -8,24 +8,23 @@ API Reference for the ``llama-index`` package.
.. toctree::
:maxdepth: 1
+ callbacks.rst
+ composability.rst
+ evaluation.rst
+ example_notebooks.rst
+ finetuning.rst
indices.rst
- query.rst
- node.rst
llm_predictor.rst
llms.rst
- prompts.rst
- service_context/embeddings.rst
+ memory.rst
node_postprocessor.rst
- storage.rst
- composability.rst
+ node.rst
+ playground.rst
+ prompts.rst
+ query.rst
readers.rst
+ response.rst
service_context.rst
- callbacks.rst
+ service_context/embeddings.rst
+ storage.rst
struct_store.rst
- evaluation.rst
- response.rst
- playground.rst
- finetuning.rst
- memory.rst
- example_notebooks.rst
- langchain_integrations/base.rst
diff --git a/docs/api_reference/node.rst b/docs/api_reference/node.rst
index e243369301..24e45b78a8 100644
--- a/docs/api_reference/node.rst
+++ b/docs/api_reference/node.rst
@@ -3,7 +3,5 @@
Node
=================
-.. automodule:: llama_index.schema
- :members:
- :inherited-members:
- :exclude-members: NodeType, ImageNode, IndexNode, TextNode
+.. automodapi:: llama_index.schema
+ :no-inheritance-diagram:
diff --git a/docs/api_reference/readers.rst b/docs/api_reference/readers.rst
index 7e9fde19cc..e75b1e2f7e 100644
--- a/docs/api_reference/readers.rst
+++ b/docs/api_reference/readers.rst
@@ -6,6 +6,5 @@ LlamaHub is an open-source repository containing data loaders that you can easil
The following data connectors are still available in the core repo.
-.. automodule:: llama_index.readers
- :members:
- :inherited-members:
+.. automodapi:: llama_index.readers
+ :no-inheritance-diagram:
diff --git a/docs/api_reference/service_context/node_parser.rst b/docs/api_reference/service_context/node_parser.rst
index f005686dba..dc13128bce 100644
--- a/docs/api_reference/service_context/node_parser.rst
+++ b/docs/api_reference/service_context/node_parser.rst
@@ -1,9 +1,8 @@
Node Parser
===========
-.. automodule:: llama_index.node_parser
- :members:
- :inherited-members:
+.. automodapi:: llama_index.node_parser
+ :no-inheritance-diagram:
.. autopydantic_model:: llama_index.node_parser.extractors.metadata_extractors.SummaryExtractor
diff --git a/docs/api_reference/storage/vector_store.rst b/docs/api_reference/storage/vector_store.rst
index 2bd31af333..33bc677b49 100644
--- a/docs/api_reference/storage/vector_store.rst
+++ b/docs/api_reference/storage/vector_store.rst
@@ -3,6 +3,5 @@
Vector Store
=====================
-.. automodule:: llama_index.vector_stores
- :members:
- :inherited-members:
+.. automodapi:: llama_index.vector_stores
+ :no-inheritance-diagram:
diff --git a/docs/conf.py b/docs/conf.py
index 174e71ccce..5e5975fa82 100644
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -41,8 +41,12 @@ extensions = [
"myst_nb",
"sphinxcontrib.autodoc_pydantic",
"sphinx_reredirects",
+ "sphinx_automodapi.automodapi",
]
+# automodapi requires this to avoid duplicates apparently
+numpydoc_show_class_members = False
+
myst_heading_anchors = 5
# TODO: Fix the non-consecutive header level in our docs, until then
# disable the sphinx/myst warnings
diff --git a/docs/requirements.txt b/docs/requirements.txt
index 11afec9c48..46c1d98431 100644
--- a/docs/requirements.txt
+++ b/docs/requirements.txt
@@ -10,3 +10,4 @@ sphinx_rtd_theme
pydantic<2.0.0
autodoc_pydantic
sphinx-reredirects>=0.1.2
+sphinx-automodapi==0.16.0
diff --git a/llama_index/vector_stores/__init__.py b/llama_index/vector_stores/__init__.py
index 3ac8e3d788..f010434baa 100644
--- a/llama_index/vector_stores/__init__.py
+++ b/llama_index/vector_stores/__init__.py
@@ -47,6 +47,7 @@ from llama_index.vector_stores.types import (
VectorStoreQueryResult,
)
from llama_index.vector_stores.weaviate import WeaviateVectorStore
+from llama_index.vector_stores.zep import ZepVectorStore
__all__ = [
"ElasticsearchStore",
--
GitLab