Skip to content

doc: matrix.json not valid JSON causing warning/error #790

Closed
#793
Closed
doc: matrix.json not valid JSON causing warning/error#790
#793
Assignees
NeroBurner
Labels
bugSomething isn't workingdocumentationImprovements or additions to documentation

Description

@NeroBurner
NeroBurner
opened on Jun 6, 2025
Warning, treated as error:
/builds/hunter/hunter/docs/creating-new/test/ci.rst:84:Could not lex literal_block as "JSON". Highlighting skipped.

The referenced codeblock is the following:

.. literalinclude:: ../../../.github/workflows/ci/matrix.json
  :language: JSON

The matrix.json file contains // comments, which are not valid json tripping the highlighting.

Removing the :language: JSON part fixes this warning

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

Metadata

Metadata

Assignees

Labels

bugSomething isn't workingdocumentationImprovements or additions to documentation

Type

No type

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions