mirror of
https://github.com/hwchase17/langchain
synced 2024-10-29 17:07:25 +00:00
2667ddc686
**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>
|
||
|---|---|---|
| .. | ||
| faiss_index | ||
| alibabacloud_opensearch.ipynb | ||
| analyticdb.ipynb | ||
| annoy.ipynb | ||
| atlas.ipynb | ||
| awadb.ipynb | ||
| azuresearch.ipynb | ||
| cassandra.ipynb | ||
| chroma.ipynb | ||
| clarifai.ipynb | ||
| clickhouse.ipynb | ||
| deeplake.ipynb | ||
| docarray_hnsw.ipynb | ||
| docarray_in_memory.ipynb | ||
| elasticsearch.ipynb | ||
| faiss.ipynb | ||
| hologres.ipynb | ||
| lancedb.ipynb | ||
| marqo.ipynb | ||
| matchingengine.ipynb | ||
| milvus.ipynb | ||
| mongodb_atlas.ipynb | ||
| myscale.ipynb | ||
| opensearch.ipynb | ||
| pgembedding.ipynb | ||
| pgvector.ipynb | ||
| pinecone.ipynb | ||
| qdrant.ipynb | ||
| redis.ipynb | ||
| rockset.ipynb | ||
| singlestoredb.ipynb | ||
| sklearn.ipynb | ||
| starrocks.ipynb | ||
| supabase.ipynb | ||
| tair.ipynb | ||
| tigris.ipynb | ||
| typesense.ipynb | ||
| vectara.ipynb | ||
| weaviate.ipynb | ||
| zilliz.ipynb | ||