Skip to content

Title-case documentation headings and clarify experiment output - #2

Merged
RulaHallak merged 5 commits into
mainfrom
docs/v180-updates
Oct 8, 2026
Merged

RulaHallak merged 5 commits into
mainfrom
docs/v180-updates

Conversation

@RulaHallak

Copy link
Copy Markdown
Owner

Summary

  • Title-case the DSE subsection headings in doc/USER_GUIDE.rst (DSE Parameter Exclusions and Metric Errors and Report Strategies) so they match the surrounding heading style.
  • Title-case the unified experiment output headings in doc/reporting.rst and clarify how experiment.json records the system name, Standalone and Slurm runs, unknown status, and metrics.
  • The Sphinx html_static_path and html_css_files lines were added and then removed, so doc/conf.py is not in the diff.
  • This branch also contains upstream commit 659ade63 (ci: give the Coverity scan enough CPU and memory to run in parallel), which changes .ci/pipeline/coverity_matrix.yaml. That commit is not on fork main.

Test Plan

  • Working tree on docs/v180-updates is clean and matches origin/docs/v180-updates.
  • Compared this branch with fork main using git diff origin/main...HEAD. The net change is:
    • doc/USER_GUIDE.rst (4 lines)
    • doc/reporting.rst (14 lines)
    • .ci/pipeline/coverity_matrix.yaml (10 lines)
  • git diff --check reported no whitespace errors on the documentation commits.
  • Built the HTML documentation on this branch before the stylesheet lines were added, and those lines have since been removed:
    uv sync --extra docs
    uv run sphinx-build -M html doc doc/_build
    
    Sphinx v8.2.3 finished with build succeeded and no warnings.
  • The Coverity pipeline change was not executed locally.

Additional Notes

orbalayla-nvidia and others added 5 commits October 7, 2026 12:05
…VIDIA#1084)

With a 4Gi limit cov-analyze revises from 4 workers to 1 due to memory
constraints, so the scan alone takes 22-33 minutes. With 8 CPUs and 32Gi it
runs 8 workers and takes about 4.5 minutes; the whole job takes about 5.5.
Requests stay small (1 CPU, 4Gi), so the pod still schedules easily.

Signed-off-by: Or Balayla <obalayla@nvidia.com>
Match the surrounding heading style for the DSE parameter exclusion and metric error sections.

Signed-off-by: rhallak <rhallak@nvidia.com>
Title-case the section headings and state more directly where execution records and metrics are recorded in experiment.json.

Signed-off-by: rhallak <rhallak@nvidia.com>
Signed-off-by: rhallak <rhallak@nvidia.com>
The html_static_path and html_css_files settings pointed at doc/_static/custom.css, which is not in the repository.

Signed-off-by: rhallak <rhallak@nvidia.com>
@RulaHallak
RulaHallak marked this pull request as ready for review October 8, 2026 06:23
@RulaHallak
RulaHallak merged commit b9f81a6 into main Oct 8, 2026
4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants