sage-docs 0.1.0.2__tar.gz

sage_docs-0.1.0.2/PKG-INFO

@@ -0,0 +1,13 @@
+Metadata-Version: 2.4
+Name: sage-docs
+Version: 0.1.0.2
+Summary: SAGE public documentation site
+Requires-Python: >=3.11
+Provides-Extra: docs
+Requires-Dist: zensical>=0.0.24; extra == "docs"
+Provides-Extra: test
+Requires-Dist: pytest>=8.0; extra == "test"
+Provides-Extra: full
+Requires-Dist: sage-docs[docs,test]; extra == "full"
+Provides-Extra: dev
+Requires-Dist: sage-docs[full]; extra == "dev"

sage_docs-0.1.0.2/README.md

@@ -0,0 +1,41 @@
+# sage-docs
+
+本仓库用于发布和维护 [SAGE](https://github.com/intellistream/SAGE) 的对外文档。
+
+## 文档入口
+
+- 在线文档：https://sage.org.ai/
+
+入口约定：
+
+- `sage.org.ai` 是 SAGE 产品与文档主入口
+- `lab.sage.org.ai` 是 IntelliStream 组织门户
+- `github.com/intellistream` 是代码与仓库入口
+
+## 内容范围
+
+- 快速开始与教程
+- 架构与模块说明
+- 用户指南与公开 API 文档
+- 社区与贡献信息
+
+## 源码访问说明
+
+本仓库仅包含文档内容，不包含 SAGE 核心源码。
+
+## 本地构建（维护者）
+
+```bash
+# 一键构建
+./build.sh
+
+# 本地预览
+zensical serve -a 127.0.0.1:9000
+
+# 手动构建
+zensical build --clean
+```
+
+## 引用
+
+如需学术引用，请以在线文档中的最新引用说明为准。

sage_docs-0.1.0.2/pyproject.toml

@@ -0,0 +1,31 @@
+[build-system]
+requires = ["setuptools>=68", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "sage-docs"
+version = "0.1.0.2"
+description = "SAGE public documentation site"
+requires-python = ">=3.11"
+
+dependencies = []
+
+[project.optional-dependencies]
+docs = [
+  "zensical>=0.0.24",
+]
+
+test = [
+  "pytest>=8.0",
+]
+
+full = [
+  "sage-docs[docs,test]",
+]
+
+dev = [
+  "sage-docs[full]",
+]
+
+[tool.setuptools]
+py-modules = []

sage_docs-0.1.0.2/sage_docs.egg-info/PKG-INFO

@@ -0,0 +1,13 @@
+Metadata-Version: 2.4
+Name: sage-docs
+Version: 0.1.0.2
+Summary: SAGE public documentation site
+Requires-Python: >=3.11
+Provides-Extra: docs
+Requires-Dist: zensical>=0.0.24; extra == "docs"
+Provides-Extra: test
+Requires-Dist: pytest>=8.0; extra == "test"
+Provides-Extra: full
+Requires-Dist: sage-docs[docs,test]; extra == "full"
+Provides-Extra: dev
+Requires-Dist: sage-docs[full]; extra == "dev"

sage_docs-0.1.0.2/sage_docs.egg-info/SOURCES.txt

@@ -0,0 +1,9 @@
+README.md
+pyproject.toml
+sage_docs.egg-info/PKG-INFO
+sage_docs.egg-info/SOURCES.txt
+sage_docs.egg-info/dependency_links.txt
+sage_docs.egg-info/requires.txt
+sage_docs.egg-info/top_level.txt
+tests/test_legacy_terms.py
+tests/test_links.py

sage_docs-0.1.0.2/sage_docs.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

sage_docs-0.1.0.2/sage_docs.egg-info/requires.txt

@@ -0,0 +1,12 @@
+
+[dev]
+sage-docs[full]
+
+[docs]
+zensical>=0.0.24
+
+[full]
+sage-docs[docs,test]
+
+[test]
+pytest>=8.0

sage_docs-0.1.0.2/sage_docs.egg-info/top_level.txt

@@ -0,0 +1 @@
+

sage_docs-0.1.0.2/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

sage_docs-0.1.0.2/tests/test_legacy_terms.py

@@ -0,0 +1,40 @@
+from __future__ import annotations
+
+import re
+from pathlib import Path
+
+DOCS_DIR = Path(__file__).resolve().parents[1] / "docs_src"
+
+ALLOWLIST = {
+    Path("getting-started/flownet-migration-guide.md"),
+}
+
+FORBIDDEN_PATTERNS: dict[str, re.Pattern[str]] = {
+    "import ray": re.compile(r"\bimport\s+ray\b"),
+    "from ray": re.compile(r"\bfrom\s+ray\b"),
+    "ray.init()": re.compile(r"\bray\.init\s*\("),
+    "ray.remote": re.compile(r"\bray\.remote\b"),
+    "RayQueueDescriptor": re.compile(r"\bRayQueueDescriptor\b"),
+    "RayServiceTask": re.compile(r"\bRayServiceTask\b"),
+    "ray_task.py": re.compile(r"\bray_task\.py\b"),
+    "use_ray=True": re.compile(r"\buse_ray\s*=\s*True\b"),
+}
+
+
+def test_legacy_ray_terms_are_confined_to_migration_guide() -> None:
+    violations: list[str] = []
+
+    for path in DOCS_DIR.rglob("*.md"):
+        rel_path = path.relative_to(DOCS_DIR)
+        if rel_path in ALLOWLIST:
+            continue
+
+        content = path.read_text(encoding="utf-8")
+        for term_name, pattern in FORBIDDEN_PATTERNS.items():
+            for match in pattern.finditer(content):
+                line_number = content.count("\n", 0, match.start()) + 1
+                violations.append(f"{rel_path}:{line_number}: {term_name}")
+
+    assert not violations, "Legacy Ray terms found outside migration guide:\n" + "\n".join(
+        sorted(violations)
+    )

sage_docs-0.1.0.2/tests/test_links.py

@@ -0,0 +1,93 @@
+from __future__ import annotations
+
+import re
+from pathlib import Path
+
+DOCS_DIR = Path(__file__).resolve().parents[1] / "docs_src"
+
+INLINE_LINK_RE = re.compile(r"!?\[[^\]]+\]\(([^)]+)\)")
+REF_DEF_RE = re.compile(r"^\s*\[[^\]]+\]:\s+(\S+)")
+
+EXTERNAL_PREFIXES = (
+    "http://",
+    "https://",
+    "mailto:",
+    "tel:",
+    "javascript:",
+)
+
+
+def _strip_title(target: str) -> str:
+    if target.startswith("<") and target.endswith(">"):
+        return target[1:-1].strip()
+    return target.split(maxsplit=1)[0].strip()
+
+
+def _normalize_target(target: str) -> str | None:
+    target = target.strip()
+    if not target:
+        return None
+    if target.startswith("#"):
+        return None
+    if target.startswith(EXTERNAL_PREFIXES):
+        return None
+    target = target.split("#", 1)[0].split("?", 1)[0].strip()
+    if not target:
+        return None
+    return target
+
+
+def _resolve_path(source: Path, target: str) -> Path:
+    if target.startswith("/"):
+        return DOCS_DIR / target.lstrip("/")
+    return source.parent / target
+
+
+def _candidate_paths(path: Path) -> list[Path]:
+    if path.suffix:
+        if path.suffix == ".html":
+            return [path, path.with_suffix(".md")]
+        return [path]
+
+    candidates = [path]
+    candidates.append(path.with_suffix(".md"))
+    candidates.append(path / "index.md")
+    return candidates
+
+
+def _iter_links(markdown: str) -> list[str]:
+    links: list[str] = []
+    in_fence = False
+    fence_re = re.compile(r"^\s*```")
+
+    for line in markdown.splitlines():
+        if fence_re.match(line):
+            in_fence = not in_fence
+            continue
+        if in_fence:
+            continue
+        for match in INLINE_LINK_RE.findall(line):
+            links.append(_strip_title(match))
+        ref_match = REF_DEF_RE.match(line)
+        if ref_match:
+            links.append(_strip_title(ref_match.group(1)))
+
+    return links
+
+
+def test_docs_links_exist() -> None:
+    missing: list[str] = []
+    for path in DOCS_DIR.rglob("*.md"):
+        content = path.read_text(encoding="utf-8")
+        for raw_target in _iter_links(content):
+            target = _normalize_target(raw_target)
+            if not target:
+                continue
+            resolved = _resolve_path(path, target)
+            candidates = _candidate_paths(resolved)
+            if any(candidate.exists() for candidate in candidates):
+                continue
+            display = ", ".join(str(candidate) for candidate in candidates)
+            missing.append(f"{path}:{display}")
+
+    assert not missing, "Missing linked files:\n" + "\n".join(sorted(missing))