Skip to content

Misc docs rendering fixes - #3450

Merged
ptrendx merged 5 commits into
NVIDIA:mainfrom
ksivaman:misc_rendering_fixes
Sep 1, 2026
Merged

Misc docs rendering fixes#3450
ptrendx merged 5 commits into
NVIDIA:mainfrom
ksivaman:misc_rendering_fixes

Conversation

@ksivaman

Copy link
Copy Markdown
Member

Description

Please include a brief summary of the changes, relevant motivation and context.

Fixes # (issue)

Type of change

  • Documentation change (change only to the documentation, either a fix or a new content)
  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Infra/Build change
  • Code refactoring

Changes

Please list the changes introduced in this PR:

  • Change A
  • Change B

Checklist:

  • I have read and followed the contributing guidelines
  • The functionality is complete
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes

Signed-off-by: Kirthi Shankar Sivamani <ksivamani@nvidia.com>
Signed-off-by: Kirthi Shankar Sivamani <ksivamani@nvidia.com>
# Conflicts:
#	.github/workflows/docs.yml
@ksivaman
ksivaman marked this pull request as draft August 31, 2026 22:40
@greptile-apps

greptile-apps Bot commented Aug 31, 2026

Copy link
Copy Markdown
Contributor

Greptile Summary

The PR improves documentation rendering across light and dark themes.

  • Adds responsive and dark-mode styling for SVG diagrams, output blocks, and Sphinx tabs.
  • Replaces inline presentation styles with reusable CSS classes and updates diagram markup.
  • Configures the documentation workflow to use the locally bundled version-switcher data.

Confidence Score: 5/5

The PR appears safe to merge.

No blocking failure remains.

Important Files Changed

Filename Overview
.github/workflows/docs.yml Configures documentation builds to reference the version-switcher JSON copied into the generated HTML.
docs/_static/css/diagram-colors.css Adds shared diagram classes and extensive dark-theme overrides for inline documentation SVGs.
docs/_static/css/output-style.css Restyles code-output sections and adds corresponding dark-mode presentation.
docs/_static/css/sphinx_tabs.css Adds dark-theme colors for Sphinx tab controls and panels.
docs/_static/css/svg-responsive.css Broadens responsive SVG handling and adds a dark-mode fallback for image-embedded SVGs.
docs/getting_started/index.rst Updates documentation markup to use the reusable rendering styles introduced by this PR.

Reviews (2): Last reviewed commit: "Dark mode fixes for docs diagrams, tabs ..." | Re-trigger Greptile

@ptrendx ptrendx added the 2.19 label Aug 31, 2026
pggPL and others added 2 commits September 1, 2026 10:27
- diagram-colors.css: dark variants for all remaining diagram box/text
  classes; accent color classes replacing hardcoded inline fills
- sphinx-tabs: dark styling for tabs and panels
- output blocks: class-based "Output:" / "Needs to be run on" headers
  attached to code blocks, dark variants; fix light background forced
  by pydata on rendered_html notebook outputs
- <img>-embedded SVGs: invert filter in dark mode; removed full-canvas
  white background rects so diagrams blend with the page
- inline SVGs: moved hardcoded dark inline fills to themable classes

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Signed-off-by: Pawel Gadzinski <pgadzinski@nvidia.com>
@pggPL
pggPL marked this pull request as ready for review September 1, 2026 09:45
@pggPL

pggPL commented Sep 1, 2026

Copy link
Copy Markdown
Collaborator

@ksivaman I fixed style issues and I think it looks OK

@ptrendx
ptrendx merged commit abf0ebb into NVIDIA:main Sep 1, 2026
13 of 17 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants