Fix Sphinx 4.0 support for docsite

[felixfontein]

SUMMARY

Port of ansible-community/antsibull#273. Sphinx 4 no longer accepts instantiated lexer classes.

CC @abadger @acozine @relrod

ISSUE TYPE

• Bugfix Pull Request
• Docs Pull Request

COMPONENT NAME

docs/docsite/_extensions/pygments_lexer.py

[ansibot]

The test ansible-test sanity --test docs-build [explain] failed with 1 error:

docs/docsite/rst/index.rst:125:0: literal-block-lex-error: Could not lex literal_block as "ansible-output". Highlighting skipped.

click here for bot help

[felixfontein]

The actual error is: docs/docsite/rst/user_guide/intro_getting_started.rst:125: WARNING: Could not lex literal_block as "ansible-output". Highlighting skipped.

Interestingly, it goes away with AnsibleOutputLexer(startinline=True), but also with AnsibleOutputLexer(startinline=False) and AnsibleOutputLexer(). It only happens when only the class name is specified here. (This is both for Sphinx 2.1.2, which the build process currently uses, and the latest pre-4.0 version 3.5.4.) Also interestingly, when passing on startinline directly in AnsibleOutputLexer.__init__, or even explicitly writing it into options, and at the same time just writing the class name, it also produces this error.

[felixfontein]

Well, I think I solved this. The issue is that this error should be there, but was not shown for whatever reason if the lexer was passed already instantiated. You can see on the actual output in https://docs.ansible.com/ansible/devel/user_guide/intro_getting_started.html#action-run-your-first-playbook (you need to scroll down a bit) that there's a formatting error. The reason is that the fields rescued and ignored were added to the status at some point, and the lexer does not know about them. 7ad0ea1 fixes that.

[acozine]

Tested locally. This gets rid of the Sphinx 4 error (which was: TypeError: 'AnsibleOutputLexer' object is not callable).

Note that Sphinx 4 requires Jinja2 <3.0, at least as of 4.0.1.

[webknjaz]

FWIW I've absorbed this patch into the theme for now.

[webknjaz]

FWIW I've absorbed this patch into the theme for now.

FYI if #74318 gets merged first, the current PR will become unnecessary.

[acozine]

Fixed as part of #74318.