Skip to content

Commit ab9c46d

Browse files
committed
chore: update Sphinx documentation build paths and fix directory structure
1 parent 2e43c26 commit ab9c46d

File tree

3 files changed

+10
-5
lines changed

3 files changed

+10
-5
lines changed

.github/workflows/docs.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -31,8 +31,8 @@ jobs:
3131
- name: Build Sphinx Documentation
3232
run: |
3333
cd docs
34-
mkdir -p source/_static
35-
uv run sphinx-build -M html source build -W
34+
mkdir -p _static
35+
uv run sphinx-build -M html ./ _build -W
3636
3737
deploy:
3838
environment:

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -52,5 +52,5 @@ This will:
5252

5353
## License
5454

55-
[Apache-2.0](./LICENSE)
55+
[Apache-2.0](https://github.com/Khushiyant/tether/blob/main/LICENSE)
5656

docs/conf.py

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
import os
22
import sys
3+
import re
34
# Ensure Sphinx can find the source code
45
sys.path.insert(0, os.path.abspath("../src"))
56

@@ -8,7 +9,7 @@ def get_project_metadata():
89
import pathlib
910
import sys
1011

11-
pyproject_path = pathlib.Path(__file__).parents[2] / "pyproject.toml"
12+
pyproject_path = pathlib.Path(__file__).parents[1] / "pyproject.toml"
1213
if sys.version_info >= (3, 11):
1314
import tomllib
1415

@@ -61,4 +62,8 @@ def get_project_metadata():
6162
"source_repository": "https://github.com/Khushiyant/tenso",
6263
"source_branch": "main",
6364
"source_directory": "docs/source/",
64-
}
65+
}
66+
67+
suppress_warnings = [
68+
'myst.xref_missing', # Suppress MyST cross-reference errors
69+
]

0 commit comments

Comments
 (0)