fix: 🐛[BUG]: Docs rendering issues in generated API pages

[arnavnagzirkar]

Summary

Fixes the Sphinx rendering of the Zarr store layout ASCII trees in the AtomicDataZarrWriter and AtomicDataZarrReader docstrings. The trees now render as literal code blocks in the generated API docs instead of collapsing into a single paragraph.

Root Cause

The Zarr store layout ASCII tree in the docstrings for AtomicDataZarrWriter and AtomicDataZarrReader was written as plain indented text directly after a colon. In reStructuredText (used by Sphinx), plain indented text does not preserve whitespace, so it collapses into ordinary paragraph text, breaking the tree structure.

Change Made

File: nvalchemi/data/datapipes/backends/zarr.py

Added .. code-block:: text directives (with a blank line before and after the directive, and the tree content indented under it) for both affected docstring sections:

• AtomicDataZarrWriter docstring (~line 276): wrapped the store layout tree in .. code-block:: text
• AtomicDataZarrReader docstring (~line 1194): wrapped the store layout tree in .. code-block:: text

This ensures Sphinx renders the ASCII tree as a literal/code block, preserving indentation and line structure.

Issue

Fixes #98

Issue URL: #98

Changes

nvalchemi/data/datapipes/backends/zarr.py | 6 ++++++
1 file changed, 6 insertions(+)

Testing

• Agent ran relevant tests during development
• Linting checks passed
• Changes are minimal and focused on the issue

AI Assistance Disclosure

This pull request was prepared with the assistance of AI coding tools (GitHub Copilot). The change has been read, understood, and is owned by the human contributor submitting it, who will respond to review feedback.

[copy-pr-bot]

This pull request requires additional validation before any workflows can run on NVIDIA's runners.

Pull request vetters can view their responsibilities here.

Contributors can view more details about this message here.

[greptile-apps]

Greptile Summary

This PR fixes Sphinx rendering of the ASCII store-layout trees in the AtomicDataZarrWriter and AtomicDataZarrReader docstrings by wrapping the plain-indented text in .. code-block:: text directives. The added directives follow correct RST formatting (blank line before/after, content indented relative to the directive), so the trees will render as literal blocks in generated API docs.

• AtomicDataZarrWriter docstring (~line 276): store layout tree wrapped in .. code-block:: text.
• AtomicDataZarrReader docstring (~line 1194): same fix applied identically.

Important Files Changed

Filename	Overview
nvalchemi/data/datapipes/backends/zarr.py	Added .. code-block:: text RST directives to two docstrings so the ASCII store-layout trees render correctly in Sphinx; no logic changes.

_{Reviews (4): Last reviewed commit: "Merge branch 'main' into fix-98" | Re-trigger Greptile}