langchain/docs/extras/modules/data_connection/vectorstores/integrations
os1ma 2667ddc686
Fix make docs_build and related scripts (#7276)
**Description: a description of the change**

Fixed `make docs_build` and related scripts which caused errors. There
are several changes.

First, I made the build of the documentation and the API Reference into
two separate commands. This is because it takes less time to build. The
commands for documents are `make docs_build`, `make docs_clean`, and
`make docs_linkcheck`. The commands for API Reference are `make
api_docs_build`, `api_docs_clean`, and `api_docs_linkcheck`.

It looked like `docs/.local_build.sh` could be used to build the
documentation, so I used that. Since `.local_build.sh` was also building
API Rerefence internally, I removed that process. `.local_build.sh` also
added some Bash options to stop in error or so. Futher more added `cd
"${SCRIPT_DIR}"` at the beginning so that the script will work no matter
which directory it is executed in.

`docs/api_reference/api_reference.rst` is removed, because which is
generated by `docs/api_reference/create_api_rst.py`, and added it to
.gitignore.

Finally, the description of CONTRIBUTING.md was modified.

**Issue: the issue # it fixes (if applicable)**

https://github.com/hwchase17/langchain/issues/6413

**Dependencies: any dependencies required for this change**

`nbdoc` was missing in group docs so it was added. I installed it with
the `poetry add --group docs nbdoc` command. I am concerned if any
modifications are needed to poetry.lock. I would greatly appreciate it
if you could pay close attention to this file during the review.

**Tag maintainer**
- General / Misc / if you don't know who to tag: @baskaryan

If this PR needs any additional changes, I'll be happy to make them!

---------

Co-authored-by: Bagatur <baskaryan@gmail.com>
2023-07-11 22:05:14 -04:00
..
faiss_index
alibabacloud_opensearch.ipynb Fix make docs_build and related scripts (#7276) 2023-07-11 22:05:14 -04:00
analyticdb.ipynb
annoy.ipynb
atlas.ipynb
awadb.ipynb Fix make docs_build and related scripts (#7276) 2023-07-11 22:05:14 -04:00
azuresearch.ipynb Add New Retriever Interface with Callbacks (#5962) 2023-06-30 14:44:03 -07:00
cassandra.ipynb Fix make docs_build and related scripts (#7276) 2023-07-11 22:05:14 -04:00
chroma.ipynb Fix make docs_build and related scripts (#7276) 2023-07-11 22:05:14 -04:00
clarifai.ipynb Fix make docs_build and related scripts (#7276) 2023-07-11 22:05:14 -04:00
clickhouse.ipynb Fix make docs_build and related scripts (#7276) 2023-07-11 22:05:14 -04:00
deeplake.ipynb Added deeplake use case examples of the new features (#6528) 2023-07-10 07:04:29 -07:00
docarray_hnsw.ipynb
docarray_in_memory.ipynb
elasticsearch.ipynb docs: vectorstore upgrades 2 (#6796) 2023-06-26 22:55:04 -07:00
faiss.ipynb Fix sample in FAISS section (#7050) 2023-07-03 02:18:32 -06:00
hologres.ipynb docs: vectorstore upgrades 2 (#6796) 2023-06-26 22:55:04 -07:00
lancedb.ipynb
marqo.ipynb Fix make docs_build and related scripts (#7276) 2023-07-11 22:05:14 -04:00
matchingengine.ipynb
milvus.ipynb
mongodb_atlas.ipynb Fix make docs_build and related scripts (#7276) 2023-07-11 22:05:14 -04:00
myscale.ipynb Harrison/myscale self query (#6376) 2023-06-18 16:53:10 -07:00
opensearch.ipynb docs: vectorstore upgrades 2 (#6796) 2023-06-26 22:55:04 -07:00
pgembedding.ipynb Add pg_hnsw vectorstore integration (#6893) 2023-07-05 08:10:10 -07:00
pgvector.ipynb Fix make docs_build and related scripts (#7276) 2023-07-11 22:05:14 -04:00
pinecone.ipynb Added documentation for add_texts function for Pinecone integration (#7134) 2023-07-05 13:11:37 -04:00
qdrant.ipynb Reuse the existing collection if configured properly in Qdrant.from_texts (#7530) 2023-07-11 16:24:35 -04:00
redis.ipynb Fix make docs_build and related scripts (#7276) 2023-07-11 22:05:14 -04:00
rockset.ipynb Fix make docs_build and related scripts (#7276) 2023-07-11 22:05:14 -04:00
singlestoredb.ipynb Fix make docs_build and related scripts (#7276) 2023-07-11 22:05:14 -04:00
sklearn.ipynb docs: vectorstore upgrades 2 (#6796) 2023-06-26 22:55:04 -07:00
starrocks.ipynb Fix make docs_build and related scripts (#7276) 2023-07-11 22:05:14 -04:00
supabase.ipynb Update supabase match_docs ddl and notebook to use expected id type (#7257) 2023-07-06 09:22:41 -04:00
tair.ipynb
tigris.ipynb docs: vectorstore upgrades 2 (#6796) 2023-06-26 22:55:04 -07:00
typesense.ipynb docs: vectorstore upgrades 2 (#6796) 2023-06-26 22:55:04 -07:00
vectara.ipynb Fix make docs_build and related scripts (#7276) 2023-07-11 22:05:14 -04:00
weaviate.ipynb
zilliz.ipynb