diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml index 62e446be..12cfcc3d 100644 --- a/docs/mkdocs.yml +++ b/docs/mkdocs.yml @@ -57,6 +57,16 @@ plugins: - https://arrow.apache.org/docs/objects.inv - https://pandas.pydata.org/docs/objects.inv - mkdocs-jupyter +- ultralytics: + verbose: True + enabled: True + default_image: "assets/lancedb_and_lance.png" # Default image for all pages + add_image: True # Automatically add meta image + add_keywords: True # Add page keywords in the header tag + add_share_buttons: True # Add social share buttons + add_authors: False # Display page authors + add_desc: False + add_dates: False markdown_extensions: - admonition @@ -205,7 +215,6 @@ extra_css: extra_javascript: - "extra_js/init_ask_ai_widget.js" - - "extra_js/meta_tag.js" extra: analytics: diff --git a/docs/requirements.txt b/docs/requirements.txt index e5b8bbd3..7f34591e 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -2,4 +2,5 @@ mkdocs==1.5.3 mkdocs-jupyter==0.24.1 mkdocs-material==9.5.3 mkdocstrings[python]==0.20.0 -pydantic \ No newline at end of file +pydantic +mkdocs-ultralytics-plugin==0.0.44 \ No newline at end of file diff --git a/docs/src/extra_js/meta_tag.js b/docs/src/extra_js/meta_tag.js deleted file mode 100644 index b1349980..00000000 --- a/docs/src/extra_js/meta_tag.js +++ /dev/null @@ -1,6 +0,0 @@ -window.addEventListener('load', function() { - var meta = document.createElement('meta'); - meta.setAttribute('property', 'og:image'); - meta.setAttribute('content', '/assets/lancedb_and_lance.png'); - document.head.appendChild(meta); - }); \ No newline at end of file diff --git a/python/pyproject.toml b/python/pyproject.toml index 2eabb5bc..64dbf773 100644 --- a/python/pyproject.toml +++ b/python/pyproject.toml @@ -47,7 +47,7 @@ repository = "https://github.com/lancedb/lancedb" [project.optional-dependencies] tests = ["aiohttp", "pandas>=1.4", "pytest", "pytest-mock", "pytest-asyncio", "duckdb", "pytz", "polars>=0.19"] dev = ["ruff", "pre-commit"] -docs = ["mkdocs", "mkdocs-jupyter", "mkdocs-material", "mkdocstrings[python]"] +docs = ["mkdocs", "mkdocs-jupyter", "mkdocs-material", "mkdocstrings[python]", "mkdocs-ultralytics-plugin==0.0.44"] clip = ["torch", "pillow", "open-clip"] embeddings = ["openai>=1.6.1", "sentence-transformers", "torch", "pillow", "open-clip-torch", "cohere", "huggingface_hub", "InstructorEmbedding", "google.generativeai", "boto3>=1.28.57", "awscli>=1.29.57", "botocore>=1.31.57"]