docs: add docstrings to core client and pdoc for sdk reference genera…

…tion (#370)



---------

Co-authored-by: ChrisTho23 <[email protected]>

.github/workflows/ci.yml

@@ -17,6 +17,8 @@ jobs:
     steps:
       - uses: actions/checkout@v3
       - uses: chartboost/ruff-action@v1
+        with:
+          args: --config ci.ruff.toml
 
   ci:
     runs-on: ubuntu-latest

.gitignore

@@ -4,6 +4,8 @@ dist/
 *.egg-info/
 .pytest_cache/
 
+playground
+
 # pyenv
 .python-version
 
@@ -24,5 +26,8 @@ dmypy.json
 
 .DS_Store
 
-playground
-tests/mocks/llama-index-storage
+# Docs
+docs
+
+# Llamaindex
+tests/mocks/llama-index-storage

.vscode/extensions.json

@@ -0,0 +1,6 @@
+{
+  "recommendations": [
+    "njpwerner.autodocstring",
+    "charliermarsh.ruff"
+  ]
+}

README.md

@@ -79,3 +79,19 @@ poetry run pre-commit install
    - Create PyPi API token: https://pypi.org/manage/account/token/
    - Setup: `poetry config pypi-token.pypi your-api-token`
 9. Create a release on GitHub with the changelog
+
+### SDK Reference
+
+Note: The generated SDK reference is currently work in progress.
+
+The SDK reference is generated via pdoc. To update the reference, run the following command:
+
+```sh
+poetry run pdoc -o docs/ --docformat google langfuse
+```
+
+You need to have all extra dependencies installed to generate the reference.
+
+```sh
+poetry install --all-extras
+```

ci.ruff.toml

@@ -0,0 +1,4 @@
+# This is the Ruff config used in CI.
+# In development, ruff.toml is used instead.
+
+target-version = 'py38'