Skip to content

ENH: Migrate to Zensical #745

Description

@tobiasraabe

Legend: [x] supported by Zensical today (mapping exists); [ ] not supported/unclear
As of January 16, 2026

Checklist

  • Core Markdown pages (headings, lists, links, emphasis) -> Python Markdown
  • Definition lists (MyST deflist) -> Python Markdown def_list (enable extension)
  • Math (MyST dollarmath) -> pymdownx.arithmatex (configure; verify delimiters)
  • Code blocks + syntax highlighting -> pymdownx.highlight + superfences
  • Include/literalinclude -> pymdownx.snippets external includes (rewrite syntax)
  • Code copy button -> theme feature content.code.copy
  • Sphinx-design grids -> Zensical grids via attr_list + md_in_html (rewrite grid syntax)
  • Sphinx-design dropdowns -> collapsible admonitions/details (rewrite to ??? blocks)
  • Sphinx/MyST cross‑ref roles ({ref}, {doc}, {class}, {func}, {term}, {meth}) -> no Zensical equivalent; rewrite to Markdown links
  • Autodoc/autoprotocol API pages -> mkdocstrings is preliminary; missing cross‑refs/backlinks
  • Sphinx-click CLI docs -> no documented Zensical equivalent
  • Intersphinx/extlinks/linkcode -> no documented Zensical equivalent
  • Notebook content (.ipynb, myst_nb) -> not documented; decide on conversion
  • RST page plugin_list.rst -> convert to Markdown; replace :pypi: role with links
  • OpenGraph/social cards -> monitor Zensical roadmap for parity

References (revisit periodically)

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementNew feature or request

    Type

    No type

    Fields

    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions