docs: Set up combined page for API docs

Author: lcian

.github/workflows/ci.yml

@@ -139,7 +139,7 @@ jobs:
         run: uv run pytest clients/python
 
   docs:
-    name: Cargo Docs
+    name: Build Documentation
     runs-on: ubuntu-latest
 
     permissions:
@@ -161,20 +161,37 @@ jobs:
         with:
           key: ${{ github.job }}
 
-      - name: Build Docs
+      - name: Build Rust Docs
         run: cargo doc --workspace --all-features --no-deps
         env:
           RUSTDOCFLAGS: -Dwarnings
 
-      - run: echo '<meta http-equiv="refresh" content="0; url=objectstore/" />Redirecting to <a href="objectstore/">objectstore</a>' > target/doc/index.html
+      - uses: astral-sh/setup-uv@85856786d1ce8acfbcc2f13a5f3fbd6b938f9f41 # v7.1.2
+
+      - name: Install Python dependencies
+        run: uv sync --all-packages --all-groups --group docs
+
+      - name: Build Python Docs
+        run: |
+          mkdir -p docs/_build
+          uv run sphinx-apidoc -o clients/python/docs/ clients/python/src/ --force --module-first
+          uv run sphinx-build -vv -W -b html clients/python/docs/ docs/_build
+
+      - name: Setup combined docs directory
+        run: |
+          mkdir -p gh-pages/rust
+          mkdir -p gh-pages/python
+          cp -r target/doc/* gh-pages/rust/
+          cp -r docs/_build/* gh-pages/python/
+          echo '<h1>Objectstore API Documentation</h1><ul><li><a href="rust/">Rust Server and Client documentation</a></li><li><a href="python/">Python Client Documentation</a></li></ul>' > gh-pages/index.html
 
       - name: Setup Pages
         uses: actions/configure-pages@v5
 
       - name: Upload artifact
         uses: actions/upload-pages-artifact@v3
         with:
-          path: "target/doc"
+          path: "gh-pages"
 
       - name: Deploy to GitHub Pages
         uses: actions/deploy-pages@v4

clients/python/docs/conf.py

@@ -0,0 +1,27 @@
+# type: ignore
+import os
+import sys
+
+sys.path.insert(0, os.path.abspath("../src"))
+
+project = "objectstore-client"
+copyright = "2025, Sentry"
+author = "Sentry"
+
+extensions = [
+    "sphinx.ext.autodoc",
+    "sphinx.ext.viewcode",
+    "sphinx.ext.napoleon",
+]
+
+templates_path = ["_templates"]
+exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
+
+html_theme = "sphinx_rtd_theme"
+html_static_path = []
+
+autodoc_default_options = {
+    "members": True,
+    "undoc-members": True,
+    "show-inheritance": True,
+}

clients/python/docs/index.rst

@@ -0,0 +1,17 @@
+Objectstore Python Client
+======================================
+
+This package provides a Python Client to interact with the Objectstore service.
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:
+
+   modules
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`

clients/python/docs/modules.rst

@@ -0,0 +1,7 @@
+src
+===
+
+.. toctree::
+   :maxdepth: 4
+
+   objectstore_client

clients/python/docs/objectstore_client.rst

@@ -0,0 +1,34 @@
+objectstore\_client package
+===========================
+
+.. automodule:: objectstore_client
+   :members:
+   :show-inheritance:
+   :undoc-members:
+
+Submodules
+----------
+
+objectstore\_client.client module
+---------------------------------
+
+.. automodule:: objectstore_client.client
+   :members:
+   :show-inheritance:
+   :undoc-members:
+
+objectstore\_client.metadata module
+-----------------------------------
+
+.. automodule:: objectstore_client.metadata
+   :members:
+   :show-inheritance:
+   :undoc-members:
+
+objectstore\_client.metrics module
+----------------------------------
+
+.. automodule:: objectstore_client.metrics
+   :members:
+   :show-inheritance:
+   :undoc-members:

pyproject.toml

@@ -2,6 +2,9 @@
 name = "objectstore"
 version = "0.1.0"
 requires-python = ">=3.13"
+dependencies = [
+    "packaging>=25.0",
+]
 
 [tool.uv]
 required-version = "==0.9.3" # keep in sync with devenv/config.ini
@@ -19,6 +22,10 @@ dev = [
     "ruff>=0.14.2",
     "pre-commit>=4.2.0",
 ]
+docs = [
+    "sphinx>=8.1.3",
+    "sphinx-rtd-theme>=3.0.1",
+]
 
 [tool.ruff.lint]
 select = ["E", "F", "I", "UP"] # pycodestyle, pyflakes, isort, pyupgrade