diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index 91657726..b6612173 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -48,7 +48,7 @@ jobs: - name: Upload artifact uses: actions/upload-pages-artifact@v1 with: - path: "site" + path: "docs/site" - name: Deploy to GitHub Pages id: deployment uses: actions/deploy-pages@v1 diff --git a/.gitignore b/.gitignore index a963eafe..6f3c4a51 100644 --- a/.gitignore +++ b/.gitignore @@ -8,4 +8,5 @@ rust/Cargo.lock site -.pytest_cache \ No newline at end of file +.pytest_cache +.ruff_cache diff --git a/mkdocs.yml b/docs/mkdocs.yml similarity index 75% rename from mkdocs.yml rename to docs/mkdocs.yml index d23cdb90..92243b79 100644 --- a/mkdocs.yml +++ b/docs/mkdocs.yml @@ -1,4 +1,5 @@ site_name: LanceDB Documentation +docs_dir: src theme: name: "material" @@ -9,4 +10,4 @@ plugins: nav: - Home: index.md -- Python API: python.md \ No newline at end of file +- Python API: python.md diff --git a/docs/index.md b/docs/src/index.md similarity index 97% rename from docs/index.md rename to docs/src/index.md index fca36679..e4c909a6 100644 --- a/docs/index.md +++ b/docs/src/index.md @@ -17,4 +17,4 @@ LanceDB's core is written in Rust 🦀 and is built using Lance, an open-source ## Documentation Quick Links * `Quick start` - search and filter a hello world vector dataset with LanceDB using the Python SDK. -* [`API Reference`](python.md) - detailed documentation for the LanceDB Python SDK. \ No newline at end of file +* [`API Reference`](python.md) - detailed documentation for the LanceDB Python SDK. diff --git a/docs/python.md b/docs/src/python.md similarity index 100% rename from docs/python.md rename to docs/src/python.md