chore: update Sphinx documentation build paths and fix directory structure

Author: Khushiyant

.github/workflows/docs.yml

@@ -3,9 +3,12 @@ on:
   push:
     branches:
       - main  # Set this to your default branch
-
+  workflow_dispatch:
+# Grant GITHUB_TOKEN the permissions to deploy to Pages
 permissions:
-  contents: write
+  contents: read
+  pages: write
+  id-token: write
 
 jobs:
   build:
@@ -31,8 +34,8 @@ jobs:
       - name: Build Sphinx Documentation
         run: |
           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
 
   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
+]