Skip to content

Replace RST code directives with markdown code blocks#196

Merged
sebastian-goeldi merged 1 commit into
mainfrom
fix/docs-code-directives
May 27, 2026
Merged

Replace RST code directives with markdown code blocks#196
sebastian-goeldi merged 1 commit into
mainfrom
fix/docs-code-directives

Conversation

@joamatab
Copy link
Copy Markdown
Contributor

@joamatab joamatab commented May 26, 2026

Summary

  • Replace .. code:: and .. code-block:: python RST directives with markdown triple-backtick code blocks in docstrings
  • ASCII art diagrams and code examples were not rendering correctly with the new docs theme because it expects markdown, not RST

Test plan

  • Verify docs build correctly
  • Check ASCII art diagrams render properly in the docs

Summary by Sourcery

Documentation:

  • Replace reStructuredText code-block directives in docstrings with Markdown triple-backtick code fences for proper rendering in the docs theme.

Replace `.. code::` and `.. code-block:: python` RST directives
with markdown triple-backtick code blocks for proper rendering
with the new docs theme.
@sourcery-ai
Copy link
Copy Markdown
Contributor

sourcery-ai Bot commented May 26, 2026

Reviewer's guide (collapsed on small PRs)

Reviewer's Guide

Converts an RST code-block directive in a docstring to a markdown-style fenced code block so that documentation renders correctly with the new markdown-oriented docs theme.

File-Level Changes

Change Details Files
Update a docstring example from an RST code-block directive to a fenced markdown code block for compatibility with the docs theme.
  • Replace the .. code-block:: python directive with a ```python fenced code block opener in the docstring.
  • Wrap the existing example code in closing triple backticks to complete the markdown code fence.
sky130/tech.py

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

Copy link
Copy Markdown
Contributor

@sourcery-ai sourcery-ai Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey - I've left some high level feedback:

  • The opening and closing ```python fences are indented inside the docstring, which some markdown/Sphinx renderers treat differently than top-level fences; consider unindenting the fences to column 0 (while leaving the code body indented) for more robust rendering across tools.
Prompt for AI Agents
Please address the comments from this code review:

## Overall Comments
- The opening and closing ```python fences are indented inside the docstring, which some markdown/Sphinx renderers treat differently than top-level fences; consider unindenting the fences to column 0 (while leaving the code body indented) for more robust rendering across tools.

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

Copy link
Copy Markdown

@gemini-code-assist gemini-code-assist Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This pull request updates the docstring in sky130/tech.py by replacing a Sphinx-style .. code-block:: python directive with standard markdown code block backticks. There are no review comments to address, and I have no additional feedback to provide.

@sebastian-goeldi sebastian-goeldi merged commit 848ae36 into main May 27, 2026
8 checks passed
@sebastian-goeldi sebastian-goeldi deleted the fix/docs-code-directives branch May 27, 2026 00:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants