Skip to content

Support third‑party Sphinx directives (e.g., mermaid) in ubcode-rst-lint #65

@DukeOfKirkcaldy

Description

@DukeOfKirkcaldy

Is your feature request related to a problem? Please describe.
When using ubcode-rst-lint inside VS Code, any .. mermaid:: directive triggers the following warning:

Image

This directive is provided by the sphinxcontrib-mermaid extension, which is commonly used in Sphinx-based documentation projects. The linter currently does not recognize it even when the extension is enabled in the project’s Sphinx configuration.

Describe the solution you'd like
I would like ubcode-rst-lint to recognizs and accept the mermaid directive when the sphinxcontrib-mermaid extension is listed in the Sphinx configuration. Ideally, the linter should automatically load and respect third‑party Sphinx directives declared in conf.py.

Describe alternatives you've considered
I tried to suppress the warning for the mermaid directive, but it can only be disabled globally. This would cause all unknown directive warnings to be hidden, not just the Mermaid-related ones.

Additional context
None.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions