Skip to content

Commit eb9ef80

Browse files
authored
Merge pull request #676 from ThalesGroup/codex/explain-hf-runtime-url
Guard Hugging Face runtime URL docs
2 parents c206621 + 55178c3 commit eb9ef80

3 files changed

Lines changed: 17 additions & 2 deletions

File tree

docs/.docs_source_mirror_stamp.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,8 @@
22
"file_count": 276,
33
"format_version": 1,
44
"managed_target": "docs/source",
5-
"source_digest_sha256": "261c525c294e43cfbf6846b7f8f2165ee8fb3da7a82869087dc4e0d49266c2d5",
5+
"source_digest_sha256": "b621157f587d6c0ba45930f96810875a913fe0b9e621a8b260382a4302e68a61",
66
"source_hint": "../thales_agilab/docs/source",
77
"sync_tool": "tools/sync_docs_source.py",
8-
"target_digest_sha256": "261c525c294e43cfbf6846b7f8f2165ee8fb3da7a82869087dc4e0d49266c2d5"
8+
"target_digest_sha256": "b621157f587d6c0ba45930f96810875a913fe0b9e621a8b260382a4302e68a61"
99
}

docs/source/apps-pages.rst

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -85,6 +85,12 @@ hosted demo or future UI adapters.
8585
url = "https://jpmorard-agilab.hf.space/?active_app=pytorch_playground_project"
8686
capabilities = ["hosted-demo", "live-training"]
8787
88+
Use the ``*.hf.space`` runtime URL for app-surface backends because it opens
89+
the running Space directly and preserves the ``active_app`` route. Use the
90+
Hugging Face project page, for example
91+
``https://huggingface.co/spaces/jpmorard/agilab``, for public badges,
92+
release-proof links, and documentation entry points.
93+
8894
The generic launcher is::
8995

9096
agilab app surface pytorch_playground_project --ui streamlit

test/test_audit_response_docs.py

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -125,6 +125,15 @@ def test_faq_separates_public_and_maintainer_docs_paths() -> None:
125125
assert "../thales_agilab/docs/source" not in faq
126126

127127

128+
def test_apps_pages_explains_huggingface_runtime_url_role() -> None:
129+
docs = (DOCS_SOURCE / "apps-pages.rst").read_text(encoding="utf-8")
130+
131+
assert "Use the ``*.hf.space`` runtime URL for app-surface backends" in docs
132+
assert "preserves the ``active_app`` route" in docs
133+
assert "https://huggingface.co/spaces/jpmorard/agilab" in docs
134+
assert "release-proof links, and documentation entry points" in docs
135+
136+
128137
def test_security_policy_addresses_public_audit_adoption_boundaries() -> None:
129138
security = Path("SECURITY.md").read_text(encoding="utf-8")
130139

0 commit comments

Comments
 (0)