Add docs-as-code documentation for test_scenarios - #36
Open
Subramanian-K812 wants to merge 1 commit into
Open
Subramanian-K812 wants to merge 1 commit into
Subramanian-K812 wants to merge 1 commit into
Conversation
Subramanian-K812
force-pushed
the
Subramanian-K812_add_docs_as_code
branch
from
September 23, 2026 09:24
68d016e to
aacc685
Compare
PiotrKorkus
requested changes
Sep 23, 2026
PiotrKorkus
left a comment
Contributor
There was a problem hiding this comment.
add docs build and deploy in ci
Subramanian-K812
force-pushed
the
Subramanian-K812_add_docs_as_code
branch
2 times, most recently
from
September 24, 2026 05:03
f4dd93d to
6b30419
Compare
Subramanian-K812
force-pushed
the
Subramanian-K812_add_docs_as_code
branch
from
September 24, 2026 05:22
6b30419 to
f985216
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Add docs-as-code documentation for test_scenarios and testing_utils
Adds a minimal docs-as-code setup covering both
test_scenarios_cpp/test_scenarios_rustandtesting_utilswired throughscore_docs_as_code.What this PR does
docs/index.rst— a minimalistic general-concepts and usage doc:Scenario,ScenarioGroup/ScenarioGroupImpl,TestContext, andrun_cli_appfor the C++/Rustscenario libraries (pointing at the real
basicexamples), plus a short section ontesting_utils's build-tool helpers,LogContainer, andResultEntry.docs/conf.py— Sphinx config matchingkyron's current, CI-verified setup exactly,including
score_metrics/sphinx_mounts/score_mounts(see Verification below for whythese three specifically are required).
BUILD— wires thedocs()macro oversource_dir = "docs". Thescore_platform/score_processneeds_jsonentries indataare left commented out, matching the onepattern already proven safe in
kyron's live, currently-passing CI: those two are declaredas
dev_dependencyinMODULE.bazelfor future readiness but never actually referenced byany built target, so they stay invisible-but-harmless if this module is ever aggregated by
another root module (e.g.
reference_integration) that would otherwise lose visibility intodev_dependency-only deps.MODULE.bazel— addsscore_docs_as_code(regular dep,8.0.1) andscore_platform/score_process(dev deps,0.7.1/1.5.4— matchingkyron's current pins)..gitignore— adds/_build(root-level Sphinx artifact frombazel run //:docs/IDEtooling; not covered by the existing
docs/_build/rule), matchingkyron's own fix for theidentical artifact.
requirements.txt.lock— regenerated; thescore_docs_as_codedependency chain bumpsscore_toolingtransitively, which bumps one of its own pip pins (pygments).Files
docs/index.rst— new, documentation contentdocs/conf.py— new, Sphinx configurationBUILD— adds thedocs()targetMODULE.bazel— addsscore_docs_as_code,score_platform,score_process.gitignore— adds/_buildrequirements.txt.lock— regenerated (transitivescore_toolingbump)Verification
bazel build //...— clean, 30/30 targets, realmetrics.jsonproducedbazel test //... --config=x86_64-linux— 2/2 tests passbazel test //:requirements.test— pass (after regenerating the lock file)bazel test --config=clang-tidy //score/test_scenarios_cpp:clang_tidy— passcargo clippy --locked --all-targets -- -D warnings— clean, 0 warningsruff check . --exclude scripts/internal— all checks passed