Skip to content

Fix docutil error when building docs#365

Open
oleksandr-pavlyk wants to merge 2 commits into
NVIDIA:mainfrom
oleksandr-pavlyk:fix-docutil-error-when-building-docs
Open

Fix docutil error when building docs#365
oleksandr-pavlyk wants to merge 2 commits into
NVIDIA:mainfrom
oleksandr-pavlyk:fix-docutil-error-when-building-docs

Conversation

@oleksandr-pavlyk
Copy link
Copy Markdown
Collaborator

When building documentation using #323 locally, encountered

/home/opavlyk/miniforge/envs/nvbench-docs/lib/python3.14/site-packages/cuda/bench/__init__.py:docstring of cuda.bench.register:18: ERROR: Unexpected indentation. [docutils]

This was being tripped by use of code in docstring of cuda.bench.register indented under Example header, but not carrying any RST annotation as a code-block.

@oleksandr-pavlyk
Copy link
Copy Markdown
Collaborator Author

@coderabbitai full review

@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented May 15, 2026

✅ Actions performed

Full review triggered.

@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented May 15, 2026

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Enterprise

Run ID: 4e5b2e57-cafa-4c75-a687-e08579fbd298

📥 Commits

Reviewing files that changed from the base of the PR and between 44ec7de and 3458298.

📒 Files selected for processing (2)
  • python/cuda/bench/__init__.py
  • python/cuda/bench/_decorators.py
💤 Files with no reviewable changes (1)
  • python/cuda/bench/init.py

📝 Walkthrough

Summary by CodeRabbit

  • Documentation

    • Enhanced code example formatting in API documentation for improved rendering and readability.
  • Chores

    • Removed redundant module-level code assignment.

Walkthrough

Removed redundant module __doc__ assignment in __init__.py. Added reStructuredText .. code-block:: python directive to make_register docstring examples for proper code formatting in generated documentation.

Changes

Documentation and Module Metadata

Layer / File(s) Summary
Module docstring and decorator documentation
python/cuda/bench/__init__.py, python/cuda/bench/_decorators.py
Removed redundant explicit __doc__ assignment; module docstring now comes solely from the top-of-file docstring. Added reStructuredText .. code-block:: python directive to make_register docstring example for proper Python code rendering in generated docs.

Comment @coderabbitai help to get the list of available commands and usage tips.

@oleksandr-pavlyk oleksandr-pavlyk self-assigned this May 15, 2026
@github-project-automation github-project-automation Bot moved this to Todo in CCCL May 15, 2026
@oleksandr-pavlyk oleksandr-pavlyk moved this from Todo to In Review in CCCL May 15, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

Status: In Review

Development

Successfully merging this pull request may close these issues.

1 participant