Publish docs to GitHub Pages via Actions

[omkarjoshi0304]

Builds the docs with Sphinx and publishes to GitHub Pages using actions/upload-pages-artifact + actions/deploy-pages, with pinned action refs, minimal permissions, and a concurrency guard on deploy.

[coderabbitai]

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: Central YAML (base), Organization UI (inherited)

Review profile: CHILL

Plan: Enterprise

Run ID: beaa9a0e-4403-42d3-b938-98ea3948dad3

📥 Commits

Reviewing files that changed from the base of the PR and between 539900d and fd985e7.

📒 Files selected for processing (1)

• .github/workflows/docs.yaml

Included review availability: Your plan provides up to 12 included reviews per hour; 11 remain after this review.

---

📝 Summary

Summary by CodeRabbit

• Documentation

  • Documentation is automatically built and published to the project’s documentation site following eligible changes on the main branch.
  • Generated HTML is deployed through GitHub Pages, providing timely access to updated guides and reference material.

• Chores

  • Documentation builds use a consistent Python environment, restricted repository permissions, and safeguards against overlapping deployments.
  • Builds can also be started manually when needed.

Walkthrough

The pull request adds a GitHub Actions workflow that builds documentation with Python 3.12, uploads the HTML as a Pages artifact, and deploys it to GitHub Pages for pushes or manual runs on main.

Changes

Documentation Pages

Layer / File(s)	Summary
Build and deploy documentation .github/workflows/docs.yaml	Adds workflow triggers, path filters, read-only permissions, Pages concurrency, pinned actions, the documentation build job, artifact upload, and conditional deployment to GitHub Pages.

Estimated code review effort: 2 (Simple) | ~10 minutes

Merge Risk: ⚪ Minimal · up to fd985

The documentation workflow builds and publishes Pages only from main or manual runs, with no current merge-blocking risk identified.

🚥 Pre-merge checks | ✅ 5

✅ Passed checks (5 passed)

Check name	Status	Explanation
Title check	✅ Passed	The title clearly and concisely describes publishing documentation to GitHub Pages through GitHub Actions.
Description check	✅ Passed	The description accurately summarizes the documentation build, GitHub Pages deployment, pinned action references, permissions, and concurrency control.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0…
Linked Issues check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check	✅ Passed	Check skipped because no linked issues were found for this pull request.

Full details: Docstring Coverage

Explanation

No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0 files. (1 skipped: 1 unsupported.)

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests

---

_{Comment @coderabbitai help to get the list of available commands.}

[lpiwowar]

/approve

Couple of non-blocking comments. I think it would be nice if you took a look @omkarjoshi0304 but not a big deal:).

[openshift-ci]

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: lpiwowar, omkarjoshi0304

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Details

Needs approval from an approver in each of these files:

• OWNERS [lpiwowar]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment