-
Notifications
You must be signed in to change notification settings - Fork 15.9k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
408 changed files
with
28,339 additions
and
5,283 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,20 +1,24 @@ | ||
<!-- Thank you for contributing to LangChain! | ||
Thank you for contributing to LangChain! | ||
|
||
Please title your PR "<package>: <description>", where <package> is whichever of langchain, community, core, experimental, etc. is being modified. | ||
Checklist: | ||
|
||
Replace this entire comment with: | ||
- **Description:** a description of the change, | ||
- **Issue:** the issue # it fixes if applicable, | ||
- **Dependencies:** any dependencies required for this change, | ||
- **Twitter handle:** we announce bigger features on Twitter. If your PR gets announced, and you'd like a mention, we'll gladly shout you out! | ||
Please make sure your PR is passing linting and testing before submitting. Run `make format`, `make lint` and `make test` from the root of the package you've modified to check this locally. | ||
See contribution guidelines for more information on how to write/run tests, lint, etc: https://python.langchain.com/docs/contributing/ | ||
If you're adding a new integration, please include: | ||
- [ ] PR title: Please title your PR "package: description", where "package" is whichever of langchain, community, core, experimental, etc. is being modified. Use "docs: ..." for purely docs changes, "templates: ..." for template changes, "infra: ..." for CI changes. | ||
- Example: "community: add foobar LLM" | ||
- [ ] PR message: **Delete this entire template message** and replace it with the following bulleted list | ||
- **Description:** a description of the change | ||
- **Issue:** the issue # it fixes, if applicable | ||
- **Dependencies:** any dependencies required for this change | ||
- **Twitter handle:** if your PR gets announced, and you'd like a mention, we'll gladly shout you out! | ||
- [ ] Pass lint and test: Run `make format`, `make lint` and `make test` from the root of the package(s) you've modified to check that you're passing lint and testing. See contribution guidelines for more information on how to write/run tests, lint, etc: https://python.langchain.com/docs/contributing/ | ||
- [ ] Add tests and docs: If you're adding a new integration, please include | ||
1. a test for the integration, preferably unit tests that do not rely on network access, | ||
2. an example notebook showing its use. It lives in `docs/docs/integrations` directory. | ||
|
||
If no one reviews your PR within a few days, please @-mention one of @baskaryan, @eyurtsev, @hwchase17. | ||
--> | ||
Additional guidelines: | ||
- Make sure optional dependencies are imported within a function. | ||
- Please do not add dependencies to pyproject.toml files (even optional ones) unless they are required for unit tests. | ||
- Most PRs should not touch more than one package. | ||
- Changes should be backwards compatible. | ||
- If you are adding something to community, do not re-import it in langchain. | ||
|
||
If no one reviews your PR within a few days, please @-mention one of baskaryan, efriis, eyurtsev, hwchase17. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,52 @@ | ||
name: API docs build | ||
|
||
on: | ||
workflow_dispatch: | ||
schedule: | ||
- cron: '0 13 * * *' | ||
env: | ||
POETRY_VERSION: "1.7.1" | ||
PYTHON_VERSION: "3.10" | ||
|
||
jobs: | ||
build: | ||
runs-on: ubuntu-latest | ||
steps: | ||
- uses: actions/checkout@v4 | ||
with: | ||
ref: bagatur/api_docs_build | ||
|
||
- name: Set Git config | ||
run: | | ||
git config --local user.email "[email protected]" | ||
git config --local user.name "Github Actions" | ||
- name: Merge master | ||
run: | | ||
git fetch origin master | ||
git merge origin/master -m "Merge master" --allow-unrelated-histories -X theirs | ||
- name: Set up Python ${{ env.PYTHON_VERSION }} + Poetry ${{ env.POETRY_VERSION }} | ||
uses: "./.github/actions/poetry_setup" | ||
with: | ||
python-version: ${{ env.PYTHON_VERSION }} | ||
poetry-version: ${{ env.POETRY_VERSION }} | ||
cache-key: api-docs | ||
|
||
- name: Install dependencies | ||
run: | | ||
poetry run python -m pip install --upgrade --no-cache-dir pip setuptools | ||
poetry run python -m pip install --upgrade --no-cache-dir sphinx readthedocs-sphinx-ext | ||
poetry run python -m pip install ./libs/partners/* | ||
poetry run python -m pip install --exists-action=w --no-cache-dir -r docs/api_reference/requirements.txt | ||
- name: Build docs | ||
run: | | ||
poetry run python -m pip install --upgrade --no-cache-dir pip setuptools | ||
poetry run python docs/api_reference/create_api_rst.py | ||
poetry run python -m sphinx -T -E -b html -d _build/doctrees -c docs/api_reference docs/api_reference api_reference_build/html -j auto | ||
# https://github.com/marketplace/actions/add-commit | ||
- uses: EndBug/add-and-commit@v9 | ||
with: | ||
message: 'Update API docs build' |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.