github/langchain
1
0
Fork 0
mirror of https://github.com/hwchase17/langchain.git synced 2025-09-05 21:12:48 +00:00
Code Issues Packages Projects Releases Wiki Activity

Feature: linkcheck-action (#534) (#542)

Browse Source 
- Add support for local build and linkchecking of docs
- Add GitHub Action to automatically check links before prior to
publication
- Minor reformat of Contributing readme
- Fix existing broken links

Co-authored-by: Hunter Gerlach <hunter@huntergerlach.com>

Co-authored-by: Hunter Gerlach <HunterGerlach@users.noreply.github.com>
Co-authored-by: Hunter Gerlach <hunter@huntergerlach.com>
This commit is contained in:
Harrison Chase
2023-01-04 21:39:50 -08:00
committed by GitHub
parent 5aefc2b7ce
commit 9753bccc71
32 changed files with 865 additions and 220 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
docs/modules/utils/combine_docs_how_to.rst
View File

@@ -5,13 +5,13 @@ There are a lot of different utilities that LangChain provides integrations for
These guides go over how to use them.
The utilities here are all utilities that make it easier to work with documents.
`Text Splitters <combine_docs_examples/textsplitter.html>`_: A walkthrough of how to split large documents up into smaller, more manageable pieces of text.
`Text Splitters <./combine_docs_examples/textsplitter.html>`_: A walkthrough of how to split large documents up into smaller, more manageable pieces of text.
`VectorStores <combine_docs_examples/vectorstores.html>`_: A walkthrough of vectorstore functionalities, and different types of vectorstores, that LangChain supports.
`VectorStores <./combine_docs_examples/vectorstores.html>`_: A walkthrough of vectorstore functionalities, and different types of vectorstores, that LangChain supports.
`Embeddings <combine_docs_examples/embeddings.html>`_: A walkthrough of embedding functionalities, and different types of embeddings, that LangChain supports.
`Embeddings <./combine_docs_examples/embeddings.html>`_: A walkthrough of embedding functionalities, and different types of embeddings, that LangChain supports.
`HyDE <combine_docs_examples/hyde.html>`_: How to use Hypothetical Document Embeddings, a novel way of constructing embeddings for document retrieval systems.
`HyDE <./combine_docs_examples/hyde.html>`_: How to use Hypothetical Document Embeddings, a novel way of constructing embeddings for document retrieval systems.
.. toctree::
:maxdepth: 1

12
docs/modules/utils/generic_how_to.rst
View File

@@ -5,15 +5,15 @@ There are a lot of different utilities that LangChain provides integrations for
These guides go over how to use them.
The utilities listed here are all generic utilities.
`Bash <examples/bash.html>`_: How to use a bash wrapper to execute bash commands.
`Bash <./examples/bash.html>`_: How to use a bash wrapper to execute bash commands.
`Python REPL <examples/python.html>`_: How to use a Python wrapper to execute python commands.
`Python REPL <./examples/python.html>`_: How to use a Python wrapper to execute python commands.
`Requests <examples/requests.html>`_: How to use a requests wrapper to interact with the web.
`Requests <./examples/requests.html>`_: How to use a requests wrapper to interact with the web.
`Google Search <examples/google_search.html>`_: How to use the google search wrapper to search the web.
`Google Search <./examples/google_search.html>`_: How to use the google search wrapper to search the web.
`SerpAPI <examples/serpapi.html>`_: How to use the SerpAPI wrapper to search the web.
`SerpAPI <./examples/serpapi.html>`_: How to use the SerpAPI wrapper to search the web.
.. toctree::
@@ -21,4 +21,4 @@ The utilities listed here are all generic utilities.
:glob:
:hidden:
examples/*
./examples/*

8
docs/modules/utils/how_to_guides.rst
View File

@@ -5,13 +5,13 @@ There are a lot of different utilities that LangChain provides integrations for
These guides go over how to use them.
These can largely be grouped into two categories:
1. `Generic Utilities <generic_how_to.html>`_: Generic utilities, including search, python REPLs, etc.
2. `Utilities for working with Documents <combine_docs_how_to.html>`_: Utilities aimed at making it easy to work with documents (text splitting, embeddings, vectorstores, etc).
1. `Generic Utilities <./generic_how_to.html>`_: Generic utilities, including search, python REPLs, etc.
2. `Utilities for working with Documents <./combine_docs_how_to.html>`_: Utilities aimed at making it easy to work with documents (text splitting, embeddings, vectorstores, etc).
.. toctree::
:maxdepth: 1
:glob:
:hidden:
generic_how_to.rst
combine_docs_how_to.rst
./generic_how_to.rst
./combine_docs_how_to.rst