Optionally warn about not highlighted blocks

rutsky avatarrutsky created an issue

If I use automatic highlighting of python code and make typo which leads to unparseble python snippet then Sphinx silenty renders code not highlighted.

It would be nice feature if Sphinx will warn be about such blocks, where syntax highliting failed.

Comments (1)

  1. rutsky

    I monkey-patched Sphinx to fail if not highlighted block found in Buildbot project documentation: https://github.com/buildbot/buildbot/blob/e8ef280b5ab6601eb172562fbbe1df03891f535b/master/docs/conf.py#L238

    So now either code is valid Python code and highlighted as Python, or it has language explicitly specified. No silently unhighlighted Python code with unmatched brackets.

    IMHO this feature request can be quite easily implemented in Sphinx, it only requires "green light" from project developers.

  2. Log in to comment
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.