Merge pull request #11 from lancedb/changhiskhan/fix-docs

reorg docs

.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

.gitignore

@@ -8,4 +8,8 @@ rust/Cargo.lock
 
 site
 
-.pytest_cache
+.pytest_cache
+.ruff_cache
+
+python/build
+python/dist

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
+- Python API: python.md

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.
+* [`API Reference`](python.md) - detailed documentation for the LanceDB Python SDK.

python/pyproject.toml

@@ -47,4 +47,11 @@ docs = [
 ]
 
 [build-system]
-requires = ["setuptools"]
+requires = [
+  "setuptools",
+  "wheel",
+]
+build-backend = "setuptools.build_meta"
+
+[tool.distutils.bdist_wheel]
+universal = true

python/setup.py

@@ -0,0 +1,17 @@
+#  Copyright 2023 LanceDB Developers
+#
+#  Licensed under the Apache License, Version 2.0 (the "License");
+#  you may not use this file except in compliance with the License.
+#  You may obtain a copy of the License at
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+#  Unless required by applicable law or agreed to in writing, software
+#  distributed under the License is distributed on an "AS IS" BASIS,
+#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#  See the License for the specific language governing permissions and
+#  limitations under the License.
+
+import setuptools
+
+if __name__ == "__main__":
+    setuptools.setup()