mirror of
https://github.com/Motorhead1991/qemu.git
synced 2025-07-28 21:03:54 -06:00
docs/qapi-domain: add compatibility node classes
Sphinx prior to v4.0 uses different classes for rendering elements of documentation objects; add some compatibility classes to use the right node classes conditionally. Signed-off-by: John Snow <jsnow@redhat.com> Message-ID: <20250311034303.75779-10-jsnow@redhat.com> Acked-by: Markus Armbruster <armbru@redhat.com> Signed-off-by: Markus Armbruster <armbru@redhat.com>
This commit is contained in:
parent
760b37e1df
commit
6d64a27cd3
1 changed files with 16 additions and 1 deletions
|
@ -2,12 +2,27 @@
|
||||||
Sphinx cross-version compatibility goop
|
Sphinx cross-version compatibility goop
|
||||||
"""
|
"""
|
||||||
|
|
||||||
from docutils.nodes import Element
|
from typing import Callable
|
||||||
|
|
||||||
|
from docutils.nodes import Element, Node, Text
|
||||||
|
|
||||||
|
import sphinx
|
||||||
|
from sphinx import addnodes
|
||||||
from sphinx.util import nodes
|
from sphinx.util import nodes
|
||||||
from sphinx.util.docutils import SphinxDirective, switch_source_input
|
from sphinx.util.docutils import SphinxDirective, switch_source_input
|
||||||
|
|
||||||
|
|
||||||
|
SpaceNode: Callable[[str], Node]
|
||||||
|
KeywordNode: Callable[[str, str], Node]
|
||||||
|
|
||||||
|
if sphinx.version_info[:3] >= (4, 0, 0):
|
||||||
|
SpaceNode = addnodes.desc_sig_space
|
||||||
|
KeywordNode = addnodes.desc_sig_keyword
|
||||||
|
else:
|
||||||
|
SpaceNode = Text
|
||||||
|
KeywordNode = addnodes.desc_annotation
|
||||||
|
|
||||||
|
|
||||||
def nested_parse_with_titles(
|
def nested_parse_with_titles(
|
||||||
directive: SphinxDirective, content_node: Element
|
directive: SphinxDirective, content_node: Element
|
||||||
) -> None:
|
) -> None:
|
||||||
|
|
Loading…
Add table
Add a link
Reference in a new issue