Add docs to dataclass_array

PiperOrigin-RevId: 546217890

Author: Conchylicultor

dataclass_array/.readthedocs.yaml

@@ -0,0 +1,20 @@
+# Read the Docs configuration file for Sphinx projects
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+version: 2
+
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3.11"
+
+# Build documentation in the "docs/" directory with Sphinx
+sphinx:
+  configuration: docs/conf.py
+
+python:
+  install:
+    - method: pip
+      path: .
+      extra_requirements:
+        - docs

docs/conf.py

@@ -0,0 +1,22 @@
+# Copyright 2023 The dataclass_array Authors.
+#
+# 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.
+
+"""Generate the sphinx documentation."""
+
+import apitree
+
+apitree.make_project(
+    modules={'dca': 'dataclass_array'},
+    globals=globals(),
+)

docs/index.md

@@ -0,0 +1,39 @@
+<!-- mdformat off(myst not supported) -->
+
+```{include} ../README.md
+```
+
+<!--
+
+How to have a self-reference ?
+
+```{toctree}
+:hidden:
+:maxdepth: 0
+:titlesonly:
+Homepage <index>
+```
+
+-->
+
+<!--
+
+TODO(epot): Add cross-reference to v3d
+
+Visu3d <https://github.com/google-research/visu3d>
+
+-->
+
+```{toctree}
+:hidden:
+:caption: Links
+
+GitHub <https://github.com/google-research/dataclass_array>
+```
+
+```{toctree}
+:hidden:
+:caption: API
+
+api/dca/index
+```

pyproject.toml

@@ -45,6 +45,10 @@ dev = [
     "tf-nightly",
     "torch",
 ]
+docs = [
+    "sphinx-apitree[ext] @ https://github.com/conchylicultor/sphinx-apitree",
+    "dataclass_array[dev]",  # Install lazy deps
+]
 
 [tool.pyink]
 # Formatting configuration to follow Google style-guide