Initial MKDocs (#285)

This commit is contained in:
William FH
2024-04-08 13:40:21 -07:00
committed by GitHub
parent a3c4d4bdd1
commit 2e9e3b0a6c
16 changed files with 732 additions and 2 deletions
+52
View File
@@ -0,0 +1,52 @@
name: Deploy SDK Docs
on:
push:
branches:
- master
workflow_dispatch:
permissions:
contents: read
pages: write
id-token: write
concurrency:
group: "pages"
cancel-in-progress: false
jobs:
deploy:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- name: install deps
run: |
pip install poetry poethepoet
- name: Set up Python
uses: actions/setup-python@v4
with:
python-version: 3.12
cache: poetry
cache-dependency-path: 'poetry.lock'
- name: Poetry install
run: |
poetry install
poetry run pip install -r docs/docs-requirements.txt
- name: Build site
working-directory: ./docs
run: make build-docs
- name: Configure GitHub Pages
uses: actions/configure-pages@v4
- name: Upload Pages Artifact
uses: actions/upload-pages-artifact@v3
with:
path: ./docs/site/
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4
+4 -1
View File
@@ -22,6 +22,9 @@ jobs:
uses: actions/checkout@v4
- name: Check links in Markdown files
uses: gaurav-nelson/github-action-markdown-link-check@v1
with:
folder-path: 'examples/'
file-path: './README.md'
notebook-link-check:
runs-on: ubuntu-latest
@@ -45,4 +48,4 @@ jobs:
env:
LANGCHAIN_API_KEY: test
shell: bash
run: poetry run pytest -o python_files=non_python_only --check-links --ignore="*.py" -k .ipynb --check-links-ignore "https://(api|web)\.smith\.langchain\.com/.*" --check-links-ignore "https://x.com/.*" .
run: poetry run pytest -o python_files=non_python_only --check-links --ignore="*.py" -k .ipynb --check-links-ignore "https://(api|web)\.smith\.langchain\.com/.*" --check-links-ignore "https://x.com/.*" ./examples