Skip to content

Commit

Permalink
update python api ref (#1251)
Browse files Browse the repository at this point in the history
preview:
https://langsmith-sdk.readthedocs.io/en/bagatur-update_py_api_ref/

build locally with
```bash
make api_docs_build
```

clean up with 
```bash
make api_docs_clean
```
  • Loading branch information
baskaryan authored Dec 3, 2024
1 parent 94eabad commit 5ae8a60
Show file tree
Hide file tree
Showing 15 changed files with 219 additions and 27 deletions.
1 change: 1 addition & 0 deletions .readthedocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@ build:
- . .venv/bin/activate
- uv pip install -r python/docs/requirements.txt
- . .venv/bin/activate && cd python/docs && make clobber generate-api-rst html && cd ../..
- cp python/docs/_build/html/reference.html python/docs/_build/html/index.html
- cp -r python/docs/_build/html $READTHEDOCS_OUTPUT
# Build documentation in the docs/ directory with Sphinx
sphinx:
Expand Down
10 changes: 10 additions & 0 deletions python/Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -62,3 +62,13 @@ build:

publish:
poetry publish --dry-run

api_docs_build:
poetry run python docs/create_api_rst.py
cd docs && poetry run make html
poetry run python docs/scripts/custom_formatter.py docs/_build/html/
cp docs/_build/html/{reference,index}.html
open docs/_build/html/index.html

api_docs_clean:
git clean -fd ./docs/
15 changes: 10 additions & 5 deletions python/docs/_static/wordmark-api-dark.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading

0 comments on commit 5ae8a60

Please sign in to comment.