chore: update Sphinx documentation build paths and fix directory structure

Author: Khushiyant

.github/workflows/docs.yml

@@ -2,10 +2,13 @@ name: Build and Deploy Docs
 on:
   push:
     branches:
-      - main  # Set this to your default branch
+      - main
+  workflow_dispatch:
 
 permissions:
-  contents: write
+  contents: read
+  pages: write
+  id-token: write
 
 jobs:
   build:
@@ -25,14 +28,24 @@ jobs:
           python-version: "3.10"
 
       - name: Install dependencies
+        # Ensure 'docs' extra is defined in your pyproject.toml
         run: |
           uv sync --extra docs
 
       - name: Build Sphinx Documentation
         run: |
+          # Generate RST files if they are not already committed
+          uv run sphinx-apidoc -o docs/ src/tether/
           cd docs
-          mkdir -p source/_static 
-          uv run sphinx-build -M html source build -W
+          mkdir -p _static 
+          uv run sphinx-build -M html ./ _build -W
+
+      - name: Upload artifact
+        # This is the missing piece that links the jobs
+        uses: actions/upload-pages-artifact@v3
+        with:
+          # Path to the generated HTML files
+          path: docs/_build/html
 
   deploy:
     environment:

.gitignore

@@ -10,4 +10,8 @@ wheels/
 .venv
 uv.lock
 input.txt
+
+# Sphinx build artifacts
 docs/_build/
+docs/tether.*.rst
+docs/modules.rst

README.md

@@ -52,5 +52,5 @@ This will:
 
 ## License
 
-[Apache-2.0](./LICENSE)
+[Apache-2.0](https://github.com/Khushiyant/tether/blob/main/LICENSE)
 

docs/conf.py

@@ -1,5 +1,6 @@
 import os
 import sys
+import re
 # Ensure Sphinx can find the source code
 sys.path.insert(0, os.path.abspath("../src"))
 
@@ -8,7 +9,7 @@ def get_project_metadata():
     import pathlib
     import sys
 
-    pyproject_path = pathlib.Path(__file__).parents[2] / "pyproject.toml"
+    pyproject_path = pathlib.Path(__file__).parents[1] / "pyproject.toml"
     if sys.version_info >= (3, 11):
         import tomllib
 
@@ -61,4 +62,8 @@ def get_project_metadata():
     "source_repository": "https://github.com/Khushiyant/tenso",
     "source_branch": "main",
     "source_directory": "docs/source/",
-}
+}
+
+suppress_warnings = [
+    'myst.xref_missing',  # Suppress MyST cross-reference errors
+]