Proxmox-Port/qemu
1
0
Fork 0
mirror of https://github.com/qemu/qemu.git synced 2025-08-14 20:31:47 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

docs/qapidoc: linting fixes

Browse Source 
This restores the linting baseline in qapidoc. The order of some imports
change slightly here due to configuring isort a little better:
previously, isort was having difficulty understanding that "compat" and
"qapidoc_legacy" were local modules because docs/sphinx "isn't a python
package". Configuring this manually, isort chooses a different import
ordering, which _is_ intentional here.

Also: extra ignores are added for pylint. The most recent versions of
pylint don't require these ignores, but the oldest versions we support
do, so in the extra ignores go.

Signed-off-by: John Snow <jsnow@redhat.com>
Reviewed-by: Markus Armbruster <armbru@redhat.com>
Message-id: 20250604200354.459501-3-jsnow@redhat.com
This commit is contained in:
John Snow 2025-06-04 16:03:50 -04:00
parent dc955052b4
commit a738817c1d
2 changed files with 17 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

25
docs/sphinx/qapi_domain.py
View File

@ -20,16 +20,6 @@
from docutils import nodes from docutils import nodes
from docutils.parsers.rst import directives from docutils.parsers.rst import directives
from compat import (
CompatField,
CompatGroupedField,
CompatTypedField,
KeywordNode,
ParserFix,
Signature,
SpaceNode,
)
from sphinx import addnodes from sphinx import addnodes
from sphinx.directives import ObjectDescription from sphinx.directives import ObjectDescription
from sphinx.domains import ( from sphinx.domains import (
@ -44,6 +34,16 @@
from sphinx.util.docutils import SphinxDirective from sphinx.util.docutils import SphinxDirective
from sphinx.util.nodes import make_id, make_refnode from sphinx.util.nodes import make_id, make_refnode
from compat import (
CompatField,
CompatGroupedField,
CompatTypedField,
KeywordNode,
ParserFix,
Signature,
SpaceNode,
)
if TYPE_CHECKING: if TYPE_CHECKING:
from typing import ( from typing import (
@ -56,7 +56,6 @@
) )
from docutils.nodes import Element, Node from docutils.nodes import Element, Node
from sphinx.addnodes import desc_signature, pending_xref from sphinx.addnodes import desc_signature, pending_xref
from sphinx.application import Sphinx from sphinx.application import Sphinx
from sphinx.builders import Builder from sphinx.builders import Builder
@ -168,6 +167,8 @@ class QAPIDescription(ParserFix):
""" """
def handle_signature(self, sig: str, signode: desc_signature) -> Signature: def handle_signature(self, sig: str, signode: desc_signature) -> Signature:
# pylint: disable=unused-argument
# Do nothing. The return value here is the "name" of the entity # Do nothing. The return value here is the "name" of the entity
# being documented; for QAPI, this is the same as the # being documented; for QAPI, this is the same as the
# "signature", which is just a name. # "signature", which is just a name.
@ -210,6 +211,8 @@ def _get_fqn(self, name: Signature) -> str:
def add_target_and_index( def add_target_and_index(
self, name: Signature, sig: str, signode: desc_signature self, name: Signature, sig: str, signode: desc_signature
) -> None: ) -> None:
# pylint: disable=unused-argument
# name is the return value of handle_signature. # name is the return value of handle_signature.
# sig is the original, raw text argument to handle_signature. # sig is the original, raw text argument to handle_signature.
# For QAPI, these are identical, currently. # For QAPI, these are identical, currently.

5
docs/sphinx/qapidoc.py
View File

@ -27,6 +27,7 @@
from __future__ import annotations from __future__ import annotations
__version__ = "2.0" __version__ = "2.0"
from contextlib import contextmanager from contextlib import contextmanager
@ -56,8 +57,6 @@
QAPISchemaVisitor, QAPISchemaVisitor,
) )
from qapi.source import QAPISourceInfo from qapi.source import QAPISourceInfo
from qapidoc_legacy import QAPISchemaGenRSTVisitor # type: ignore
from sphinx import addnodes from sphinx import addnodes
from sphinx.directives.code import CodeBlock from sphinx.directives.code import CodeBlock
from sphinx.errors import ExtensionError from sphinx.errors import ExtensionError
@ -65,6 +64,8 @@
from sphinx.util.docutils import SphinxDirective, switch_source_input from sphinx.util.docutils import SphinxDirective, switch_source_input
from sphinx.util.nodes import nested_parse_with_titles from sphinx.util.nodes import nested_parse_with_titles
from qapidoc_legacy import QAPISchemaGenRSTVisitor # type: ignore
if TYPE_CHECKING: if TYPE_CHECKING:
from typing import ( from typing import (