Skip to content

Broken docs #1922

Description

@woile

Description

The docs now look like AI slop:

  • confusing, I cannot find the settings
  • wrong formatting
  • wrong titles on the sidebar

Steps to reproduce

Navigate to this for example:
https://commitizen-tools.github.io/commitizen/config/version_provider/

Current behavior

Missing headers:

Image

Wrong markdown usage:

Image Image

version_provider is nowhere to be found in bump, it's isolated under:
https://commitizen-tools.github.io/commitizen/config/version_provider/
users cannto discover it

All the titles in bump page:

Image

Desired behavior

Make it user friendly

Screenshots

No response

Environment

website

Activity

  1. self-assigned this
    on Apr 2, 2026
  2. ttw225 commented on Apr 3, 2026

    @ttw225
    Contributor

    Root cause: pygments==2.20.0 regressed HtmlFormatter so that when filename is None, it calls html.escape() on None and crashes with AttributeError: 'NoneType' object has no attribute 'replace'.

    In our MkDocs stack, pymdownx.highlight ends up passing filename=None in the common case (no fence title), so the highlight step fails; pymdownx.superfences then doesn’t replace the fence, and the remaining text is parsed as normal Markdown — which is why ```bash and lines starting with # show up as plain text / headings.

    Upstream:

    Possible mitigation until a Pygments release with the fix is available: pin pygments<2.20 for the docs build (similar approach: jj-vcs/jj#9233).

  3. woile commented on Apr 3, 2026

    @woile
    MemberAuthor

    Thanks, I'll try this out

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Type

No type

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions