Skip to content
Snippets Groups Projects
Unverified Commit d9039ae3 authored by Laurie Voss's avatar Laurie Voss Committed by GitHub
Browse files

Multiple fixes to make various API reference docs visible to Algolia (#9065)

parent 31039cc0
Branches
Tags
No related merge requests found
...@@ -17,4 +17,4 @@ help: ...@@ -17,4 +17,4 @@ help:
# Catch-all target: route all unknown targets to Sphinx using the new # Catch-all target: route all unknown targets to Sphinx using the new
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS). # "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
%: Makefile %: Makefile
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) -j 8
...@@ -8,24 +8,23 @@ API Reference for the ``llama-index`` package. ...@@ -8,24 +8,23 @@ API Reference for the ``llama-index`` package.
.. toctree:: .. toctree::
:maxdepth: 1 :maxdepth: 1
callbacks.rst
composability.rst
evaluation.rst
example_notebooks.rst
finetuning.rst
indices.rst indices.rst
query.rst
node.rst
llm_predictor.rst llm_predictor.rst
llms.rst llms.rst
prompts.rst memory.rst
service_context/embeddings.rst
node_postprocessor.rst node_postprocessor.rst
storage.rst node.rst
composability.rst playground.rst
prompts.rst
query.rst
readers.rst readers.rst
response.rst
service_context.rst service_context.rst
callbacks.rst service_context/embeddings.rst
storage.rst
struct_store.rst struct_store.rst
evaluation.rst
response.rst
playground.rst
finetuning.rst
memory.rst
example_notebooks.rst
langchain_integrations/base.rst
...@@ -3,7 +3,5 @@ ...@@ -3,7 +3,5 @@
Node Node
================= =================
.. automodule:: llama_index.schema .. automodapi:: llama_index.schema
:members: :no-inheritance-diagram:
:inherited-members:
:exclude-members: NodeType, ImageNode, IndexNode, TextNode
...@@ -6,6 +6,5 @@ LlamaHub is an open-source repository containing data loaders that you can easil ...@@ -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. The following data connectors are still available in the core repo.
.. automodule:: llama_index.readers .. automodapi:: llama_index.readers
:members: :no-inheritance-diagram:
:inherited-members:
Node Parser Node Parser
=========== ===========
.. automodule:: llama_index.node_parser .. automodapi:: llama_index.node_parser
:members: :no-inheritance-diagram:
:inherited-members:
.. autopydantic_model:: llama_index.node_parser.extractors.metadata_extractors.SummaryExtractor .. autopydantic_model:: llama_index.node_parser.extractors.metadata_extractors.SummaryExtractor
......
...@@ -3,6 +3,5 @@ ...@@ -3,6 +3,5 @@
Vector Store Vector Store
===================== =====================
.. automodule:: llama_index.vector_stores .. automodapi:: llama_index.vector_stores
:members: :no-inheritance-diagram:
:inherited-members:
...@@ -41,8 +41,12 @@ extensions = [ ...@@ -41,8 +41,12 @@ extensions = [
"myst_nb", "myst_nb",
"sphinxcontrib.autodoc_pydantic", "sphinxcontrib.autodoc_pydantic",
"sphinx_reredirects", "sphinx_reredirects",
"sphinx_automodapi.automodapi",
] ]
# automodapi requires this to avoid duplicates apparently
numpydoc_show_class_members = False
myst_heading_anchors = 5 myst_heading_anchors = 5
# TODO: Fix the non-consecutive header level in our docs, until then # TODO: Fix the non-consecutive header level in our docs, until then
# disable the sphinx/myst warnings # disable the sphinx/myst warnings
......
...@@ -10,3 +10,4 @@ sphinx_rtd_theme ...@@ -10,3 +10,4 @@ sphinx_rtd_theme
pydantic<2.0.0 pydantic<2.0.0
autodoc_pydantic autodoc_pydantic
sphinx-reredirects>=0.1.2 sphinx-reredirects>=0.1.2
sphinx-automodapi==0.16.0
...@@ -47,6 +47,7 @@ from llama_index.vector_stores.types import ( ...@@ -47,6 +47,7 @@ from llama_index.vector_stores.types import (
VectorStoreQueryResult, VectorStoreQueryResult,
) )
from llama_index.vector_stores.weaviate import WeaviateVectorStore from llama_index.vector_stores.weaviate import WeaviateVectorStore
from llama_index.vector_stores.zep import ZepVectorStore
__all__ = [ __all__ = [
"ElasticsearchStore", "ElasticsearchStore",
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment