docarray · samsja · Mar 28, 2023 · Mar 27, 2023 · Mar 27, 2023 · Mar 27, 2023
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -100,7 +100,7 @@ jobs:
       matrix:
         python-version: [3.7]
 #        test-path: ${{fromJson(needs.prep-testbed.outputs.matrix)}}
-        test-path: [tests/integrations, tests/units]
+        test-path: [tests/integrations, tests/units, tests/documentation]
     steps:
       - uses: actions/[email protected]
       - name: Set up Python ${{ matrix.python-version }}
@@ -144,7 +144,7 @@ jobs:
       fail-fast: false
       matrix:
         python-version: [3.7]
-        test-path: [tests/integrations, tests/units]
+        test-path: [tests/integrations, tests/units, tests/documentation]
     steps:
       - uses: actions/[email protected]
       - name: Set up Python ${{ matrix.python-version }}
@@ -275,7 +275,6 @@ jobs:
           poetry run pytest -m 'benchmark' tests
         timeout-minutes: 30
 
-
   # just for blocking the merge until all parallel core-test are successful
   success-all-test:
     needs: [docarray-test, docarray-test-proto3, docarray-doc-index, docarray-test-tensorflow, docarray-test-benchmarks, import-test, check-black, check-mypy, lint-ruff]

diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -23,4 +23,13 @@ repos:
 - repo: https://github.com/charliermarsh/ruff-pre-commit
   rev: v0.0.243
   hooks:
-    - id: ruff
+    - id: ruff
+
+- repo: https://github.com/asottile/blacken-docs
+  rev: 1.13.0
+  hooks:
+  -   id: blacken-docs
+      args:
+        - -S
+      additional_dependencies:
+        - black==22.3.0
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -276,6 +276,7 @@ This allows:
 If you need to monitor and debug your code, you can enable docarray logging:
 ```python
 import logging
+
 logging.getLogger('docarray').setLevel(logging.DEBUG)
 ```
 

diff --git a/docs/api_references/.pages b/docs/api_references/.pages
@@ -0,0 +1,4 @@
+nav:
+    - ...
+
+sort_type: natural
diff --git a/docs/assets/logo-dark.svg b/docs/assets/logo-dark.svg
diff --git a/docs/assets/logo-light.svg b/docs/assets/logo-light.svg
diff --git a/docs/tutorials/add_doc_index.md → docs/how_to/add_doc_index.md b/docs/tutorials/add_doc_index.md → docs/how_to/add_doc_index.md
diff --git a/...orials/multimodal_training_and_serving.md → ...how_to/multimodal_training_and_serving.md b/...orials/multimodal_training_and_serving.md → ...how_to/multimodal_training_and_serving.md
diff --git a/...ptimize_performance_with_id_generation.md → ...ptimize_performance_with_id_generation.md b/...ptimize_performance_with_id_generation.md → ...ptimize_performance_with_id_generation.md
diff --git a/docs/user_guide/first_step.md b/docs/user_guide/first_step.md
@@ -0,0 +1 @@
+# First Step : BaseDoc
diff --git a/docs/user_guide/intro.md b/docs/user_guide/intro.md
@@ -0,0 +1 @@
+# User Guide - Intro
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -1,6 +1,13 @@
-site_name: "DocArray"
+site_name: DocArray Documentation
+site_description: DocArray, DocArray is a library for representing, sending and storing multi-modal data, with a focus on applications in ML and Neural Search.
+site_url: https://docs.docarray.org/
+repo_name: docarray/docarray
+repo_url: https://github.com/docarray/docarray
+edit_uri: ''
 theme:
-#  logo: assets/favicon.png
+  logo: assets/logo-light.svg
+
+  favicon: assets/favicon.png
   name: material
   features:
 #    - navigation.sections
@@ -11,16 +18,17 @@ theme:
       primary: teal
       toggle:
         icon: material/brightness-7
-
-
         name: Switch to dark mode
 
+
     # Palette toggle for dark mode
     - scheme: slate
       primary: teal
       toggle:
         icon: material/brightness-4
         name: Switch to light mode
+#        logo: assets/docarray-light.svg
+
     #primary: teal
 markdown_extensions:
   - pymdownx.highlight:
@@ -40,12 +48,37 @@ markdown_extensions:
   - attr_list
   - md_in_html
 
+extra:
+#  analytics:
+#    provider: google
+  social:
+  - icon: fontawesome/brands/github-alt
+    link: https://github.com/docarray/docarray
+  - icon: fontawesome/brands/discord
+    link: https://discord.com/invite/WaMp6PVPgR
+  - icon: fontawesome/brands/twitter
+    link: https://twitter.com/docarray
+
 
 plugins:
   - search
+  - awesome-pages
   - mkdocstrings:
       handlers:
         python:
           options:
             docstring_style: sphinx
-            inherited_members: true
+            inherited_members: true
+
+nav:
+  - Home: README.md
+  - Tutorial - User Guide:
+    - user_guide/intro.md
+    - user_guide/first_step.md
+
+  - How-to:
+    - how_to/add_doc_index.md
+    - how_to/multimodal_training_and_serving.md
+    - how_to/optimize_performance_with_id_generation.md
+  - ...
+  - Contributing: CONTRIBUTING.md
diff --git a/poetry.lock b/poetry.lock
diff --git a/pyproject.toml b/pyproject.toml
@@ -40,6 +40,9 @@ pandas = ["pandas"]
 jac = ["jina-hubble-sdk"]
 aws = ["smart-open"]
 
+# all
+full = ["protobuf", "lz4", "pillow", "types-pillow", "av", "pydub", "trimesh"]
+
 [tool.poetry.dev-dependencies]
 pytest = ">=7.0"
 pre-commit = ">=2.20.0"
@@ -49,6 +52,7 @@ types-protobuf = ">=3.20.4"
 black = ">=22.10.0"
 isort = ">=5.10.1"
 ruff = ">=0.0.243"
+blacken-docs = ">=1.13.0"
 
 [tool.poetry.group.dev.dependencies]
 uvicorn = ">=0.19.0"
@@ -59,7 +63,8 @@ pytest-asyncio = ">=0.20.2"
 [tool.poetry.group.docs.dependencies]
 mkdocstrings = {extras = ["python"], version = ">=0.20.0"}
 mkdocs-material= ">=9.1.2"
-
+mkdocs-awesome-pages-plugin = ">=2.8.0"
+mktestdocs= ">=0.2.0"
 [build-system]
 requires = ["poetry-core>=1.0.0"]
 build-backend = "poetry.core.masonry.api"

diff --git a/tests/documentation/test_docs.py b/tests/documentation/test_docs.py
@@ -0,0 +1,13 @@
+import pathlib
+
+import pytest
+from mktestdocs import check_md_file
+
+
+# @pytest.mark.parametrize('fpath', pathlib.Path("docs").glob("**/*.md"), ids=str)
+# to use later
+@pytest.mark.parametrize(
+    'fpath', pathlib.Path('docs/user_guide').glob('**/*.md'), ids=str
+)
+def test_files_good(fpath):
+    check_md_file(fpath=fpath, memory=True)