Fix QLLexer instance as argument to add_lexer
#11353
Conversation
`add_lexer` requires a type as argument in recent versions of sphinx See https://www.sphinx-doc.org/en/master/extdev/appapi.html#sphinx.application.Sphinx.add_lexer
docs/codeql/conf.py
Outdated
| from qllexer import QLLexer | ||
| sphinx.add_lexer("ql", QLLexer()) | ||
| sphinx.add_lexer("ql", QLLexer) |
There was a problem hiding this comment.
Try this. The callable builtin should tell us whether an object is indeed callable. This way we can remain robust to different versions of Sphinx + pygments being installed, without breaking either local or CI usage.
| sphinx.add_lexer("ql", QLLexer) | |
| sphinx.add_lexer("ql", QLLexer() if callable(QLLexer) else QLLexer) |
There are actually 3 places in the code we make this call:
docs/codeql/conf.py(here)docs/codeql/ql-training/conf.pydocumentation/restructuredtext/codeql-cli/conf.pywithin the internal repo
Would you mind updating the first 2 locations in this PR, and then we can tackle the third in an internal PR?
There was a problem hiding this comment.
Thanks for the suggestion! Unfortunately, this fails with:
Exception occurred:
File "/opt/homebrew/lib/python3.10/site-packages/sphinx/highlighting.py", line 130, in get_lexer
lexer = lexer_classes[lang](**opts)
TypeError: 'QLLexer' object is not callable
I think the problem may be that QLLexer is callable regardless of the Sphinx version used. It is just add_lexer that has different expectations of how you pass the lexer in, depending on the version.
There was a problem hiding this comment.
Hmph yes good point. Thank you for trying. I wonder if we can detect from within Python what the Sphinx version is? If not I think the principled solution is the one in the internal issue - pin to a specific version of the packages.
Co-authored-by: Aditya Sharad <6874315+adityasharad@users.noreply.github.com>
add_lexerrequires a type as argument in versions of sphinx >= 2.1 (docs). Currently, an instance ofQLLexeris passed to it, which causes the docs build to fail if a version of Sphinx >= 3 is used. This PR fixes this so that the documentation can be built successfully.