Skip to content

fix: add markdown extensions for PDF tab rendering - #318

Open
jackgdsf wants to merge 1 commit into
gdsfactory:mainfrom
jackgdsf:fix/pdf-tab-rendering
Open

fix: add markdown extensions for PDF tab rendering#318
jackgdsf wants to merge 1 commit into
gdsfactory:mainfrom
jackgdsf:fix/pdf-tab-rendering

Conversation

@jackgdsf

@jackgdsf jackgdsf commented Jul 28, 2026

Copy link
Copy Markdown
Contributor

Summary

Add pymdownx.tabbed, pymdownx.superfences, and admonition markdown extensions to mkdocs-pdf.yml so content tabs and warning blocks render correctly in the release PDF.

Without these extensions, the PDF shows literal tab syntax and raw admonition markup instead of rendered content.

Same fix as doplaydo/tps45#296.

Changes

  • mkdocs-pdf.yml: Add markdown_extensions section

Test plan

  • Verify mkdocs build -f mkdocs-pdf.yml succeeds

Closes #317

Summary by Sourcery

Documentation:

  • Enable tabbed content and admonition blocks to render correctly in the PDF documentation build.

Add pymdownx.tabbed, pymdownx.superfences, and admonition so content tabs
and warning blocks render correctly in the release PDF.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
@gemini-code-assist

Copy link
Copy Markdown
Contributor

Caution

The consumer version of Gemini Code Assist on GitHub has been sunset. All code review activity has officially ceased.

@sourcery-ai

sourcery-ai Bot commented Jul 28, 2026

Copy link
Copy Markdown
Reviewer's guide (collapsed on small PRs)

Reviewer's Guide

Configures MkDocs PDF build to use the same markdown extensions as the main site so tabbed content and admonitions render correctly in generated PDFs.

Flow diagram for MkDocs PDF build with markdown extensions

flowchart TD
    A[mkdocs-pdf.yml] --> B[mkdocs build -f mkdocs-pdf.yml]
    B --> C[Markdown processing]
    C --> D[pymdownx.tabbed with alternate_style]
    C --> E[pymdownx.superfences]
    C --> F[admonition]
    D --> G[Rendered tabs in PDF]
    E --> G
    F --> H[Rendered admonitions in PDF]
Loading

File-Level Changes

Change Details Files
Enable pymdownx tabbed content, superfences, and admonition rendering in the PDF-specific MkDocs config.
  • Add a markdown_extensions section to the PDF MkDocs configuration
  • Configure pymdownx.tabbed with alternate_style set to true to match site styling for tabs
  • Enable pymdownx.superfences extension to ensure fenced code blocks inside tabs/admonitions render properly
  • Enable admonition extension so warning/info/note blocks render instead of appearing as raw markup
mkdocs-pdf.yml

Assessment against linked issues

Issue Objective Addressed Explanation
#317 Add the markdown extensions pymdownx.tabbed, pymdownx.superfences, and admonition to mkdocs-pdf.yml so that content tabs and warning/admonition blocks render correctly in the PDF.

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

@sourcery-ai sourcery-ai Bot left a comment

Copy link
Copy Markdown

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:

  • Consider inheriting from the main mkdocs.yml (via INHERIT) or otherwise keeping the markdown_extensions list in sync with it to avoid configuration drift between the HTML and PDF builds.
Prompt for AI Agents
Please address the comments from this code review:

## Overall Comments
- Consider inheriting from the main `mkdocs.yml` (via `INHERIT`) or otherwise keeping the `markdown_extensions` list in sync with it to avoid configuration drift between the HTML and PDF builds.

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.

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.

fix: add markdown extensions to mkdocs-pdf.yml

1 participant