Version
Docs site: ALCHEMI Toolkit 0.1.0
On which installation method(s) does this occur?
Source
Describe the issue
The generated API docs have rendering issues in the Zarr-backed data I/O pages.
Subissues:
Observed behavior:
The Zarr store layout ASCII tree is rendered as ordinary paragraph text, so indentation and line structure collapse. This makes the documented store hierarchy difficult to read.
Affected pages:
Source locations:
Expected behavior:
The Zarr layout should render as a literal/code block so the tree structure and indentation are preserved.
Likely fix:
Use a docstring literal block, ::, or .. code-block:: text for the layout sections.
Minimum reproducible example
Open either affected generated API page above and inspect the "Zarr store layout" section.
Relevant log output
N/A
Environment details
Docs site / generated Sphinx API documentation.
Version
Docs site: ALCHEMI Toolkit 0.1.0
On which installation method(s) does this occur?
Source
Describe the issue
The generated API docs have rendering issues in the Zarr-backed data I/O pages.
Subissues:
AtomicDataZarrWriterAtomicDataZarrReaderObserved behavior:
The Zarr store layout ASCII tree is rendered as ordinary paragraph text, so indentation and line structure collapse. This makes the documented store hierarchy difficult to read.
Affected pages:
Source locations:
Expected behavior:
The Zarr layout should render as a literal/code block so the tree structure and indentation are preserved.
Likely fix:
Use a docstring literal block,
::, or.. code-block:: textfor the layout sections.Minimum reproducible example
Open either affected generated API page above and inspect the "Zarr store layout" section.
Relevant log output
N/A
Environment details
Docs site / generated Sphinx API documentation.