From 92d810eac4c116620c46c5a878fc27e601940741 Mon Sep 17 00:00:00 2001 From: Jai Date: Sun, 14 May 2023 10:18:28 -0700 Subject: [PATCH] docs build (#78) --- .github/workflows/docs.yml | 3 +-- docs/mkdocs.yml | 7 +++++-- docs/src/python.md | 12 ++++++------ 3 files changed, 12 insertions(+), 10 deletions(-) diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index b6612173..a55e74fa 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -40,9 +40,8 @@ jobs: python -m pip install -e . python -m pip install -r ../docs/requirements.txt - name: Build docs - working-directory: docs run: | - mkdocs build + PYTHONPATH=. mkdocs build -f docs/mkdocs.yml - name: Setup Pages uses: actions/configure-pages@v2 - name: Upload artifact diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml index 8e9d3954..127772a8 100644 --- a/docs/mkdocs.yml +++ b/docs/mkdocs.yml @@ -8,7 +8,10 @@ theme: plugins: - search -- mkdocstrings +- mkdocstrings: + handlers: + python: + paths: [../python] - mkdocs-jupyter nav: @@ -26,4 +29,4 @@ markdown_extensions: pygments_lang_class: true - pymdownx.inlinehilite - pymdownx.snippets -- pymdownx.superfences +- pymdownx.superfences \ No newline at end of file diff --git a/docs/src/python.md b/docs/src/python.md index e4dbf221..cf47cc2d 100644 --- a/docs/src/python.md +++ b/docs/src/python.md @@ -6,9 +6,9 @@ pip install lancedb ``` -::: lancedb -::: lancedb.db -::: lancedb.table -::: lancedb.query -::: lancedb.embeddings -::: lancedb.context +## ::: lancedb +## ::: lancedb.db +## ::: lancedb.table +## ::: lancedb.query +## ::: lancedb.embeddings +## ::: lancedb.context