From patchwork Wed Oct 4 23:05:30 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: John Snow X-Patchwork-Id: 1843671 Return-Path: X-Original-To: incoming@patchwork.ozlabs.org Delivered-To: patchwork-incoming@legolas.ozlabs.org Authentication-Results: legolas.ozlabs.org; dkim=pass (1024-bit key; unprotected) header.d=redhat.com header.i=@redhat.com header.a=rsa-sha256 header.s=mimecast20190719 header.b=E0gwCmny; dkim-atps=neutral Authentication-Results: legolas.ozlabs.org; spf=pass (sender SPF authorized) smtp.mailfrom=nongnu.org (client-ip=209.51.188.17; helo=lists.gnu.org; envelope-from=qemu-devel-bounces+incoming=patchwork.ozlabs.org@nongnu.org; receiver=patchwork.ozlabs.org) Received: from lists.gnu.org (lists.gnu.org [209.51.188.17]) (using TLSv1.2 with cipher ECDHE-ECDSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by legolas.ozlabs.org (Postfix) with ESMTPS id 4S19L90nXmz1yq7 for ; Thu, 5 Oct 2023 10:06:40 +1100 (AEDT) Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1qoAwG-00046h-W8; Wed, 04 Oct 2023 19:05:57 -0400 Received: from eggs.gnu.org ([2001:470:142:3::10]) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1qoAwE-00045c-Ak for qemu-devel@nongnu.org; Wed, 04 Oct 2023 19:05:54 -0400 Received: from us-smtp-delivery-124.mimecast.com ([170.10.129.124]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1qoAvy-0002db-9y for qemu-devel@nongnu.org; Wed, 04 Oct 2023 19:05:54 -0400 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1696460737; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:cc:mime-version:mime-version: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references; bh=uyjIIJ+2F62+QmKF0zNHfCVY1DeAEtdWdStww0ybrtc=; b=E0gwCmnyy4Pf/Zn6/uMdHOsmPmzJf54MBETMVgymKpG85HJFe3Y+DGNGo1mRWzQXD8NosY sIYpwoKZR7q717bsAX/aGRklbc8YAfZg/dkt9+V3bNAdKepgGGbhBYpYN560RtICwTHcS/ msLJg9MHstVpjg1MSE+wGMkFEdEHmZ8= Received: from mimecast-mx02.redhat.com (mx-ext.redhat.com [66.187.233.73]) by relay.mimecast.com with ESMTP with STARTTLS (version=TLSv1.2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id us-mta-115-ClT64ZlmM0ybNnfHxNwGBA-1; Wed, 04 Oct 2023 19:05:34 -0400 X-MC-Unique: ClT64ZlmM0ybNnfHxNwGBA-1 Received: from smtp.corp.redhat.com (int-mx08.intmail.prod.int.rdu2.redhat.com [10.11.54.8]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by mimecast-mx02.redhat.com (Postfix) with ESMTPS id 9FC243C025B7; Wed, 4 Oct 2023 23:05:33 +0000 (UTC) Received: from scv.redhat.com (unknown [10.22.16.59]) by smtp.corp.redhat.com (Postfix) with ESMTP id 5892CC154CB; Wed, 4 Oct 2023 23:05:33 +0000 (UTC) From: John Snow To: qemu-devel@nongnu.org Cc: Markus Armbruster , Victor Toso de Carvalho , Peter Maydell , Michael Roth , John Snow Subject: [PATCH v5 1/3] [DO-NOT-MERGE] docs: enable sphinx-autodoc for scripts/qapi Date: Wed, 4 Oct 2023 19:05:30 -0400 Message-ID: <20231004230532.3002201-2-jsnow@redhat.com> In-Reply-To: <20231004230532.3002201-1-jsnow@redhat.com> References: <20231004230532.3002201-1-jsnow@redhat.com> MIME-Version: 1.0 X-Scanned-By: MIMEDefang 3.1 on 10.11.54.8 Received-SPF: pass client-ip=170.10.129.124; envelope-from=jsnow@redhat.com; helo=us-smtp-delivery-124.mimecast.com X-Spam_score_int: -20 X-Spam_score: -2.1 X-Spam_bar: -- X-Spam_report: (-2.1 / 5.0 requ) BAYES_00=-1.9, DKIMWL_WL_HIGH=-0.001, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, DKIM_VALID_EF=-0.1, SPF_HELO_NONE=0.001, T_SPF_TEMPERROR=0.01 autolearn=ham autolearn_force=no X-Spam_action: no action X-BeenThere: qemu-devel@nongnu.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: qemu-devel-bounces+incoming=patchwork.ozlabs.org@nongnu.org Sender: qemu-devel-bounces+incoming=patchwork.ozlabs.org@nongnu.org This is just a POC to prove that the docstrings, where they are written, are correct to some minimum standard. It is included here for reviewing/testing convenience. Signed-off-by: John Snow --- docs/conf.py | 3 ++- docs/devel/index.rst | 1 + docs/devel/python/index.rst | 7 +++++++ docs/devel/python/qapi.commands.rst | 7 +++++++ docs/devel/python/qapi.common.rst | 7 +++++++ docs/devel/python/qapi.error.rst | 7 +++++++ docs/devel/python/qapi.events.rst | 7 +++++++ docs/devel/python/qapi.expr.rst | 7 +++++++ docs/devel/python/qapi.gen.rst | 7 +++++++ docs/devel/python/qapi.introspect.rst | 7 +++++++ docs/devel/python/qapi.main.rst | 7 +++++++ docs/devel/python/qapi.parser.rst | 8 ++++++++ docs/devel/python/qapi.rst | 26 ++++++++++++++++++++++++++ docs/devel/python/qapi.schema.rst | 7 +++++++ docs/devel/python/qapi.source.rst | 7 +++++++ docs/devel/python/qapi.types.rst | 7 +++++++ docs/devel/python/qapi.visit.rst | 7 +++++++ 17 files changed, 128 insertions(+), 1 deletion(-) create mode 100644 docs/devel/python/index.rst create mode 100644 docs/devel/python/qapi.commands.rst create mode 100644 docs/devel/python/qapi.common.rst create mode 100644 docs/devel/python/qapi.error.rst create mode 100644 docs/devel/python/qapi.events.rst create mode 100644 docs/devel/python/qapi.expr.rst create mode 100644 docs/devel/python/qapi.gen.rst create mode 100644 docs/devel/python/qapi.introspect.rst create mode 100644 docs/devel/python/qapi.main.rst create mode 100644 docs/devel/python/qapi.parser.rst create mode 100644 docs/devel/python/qapi.rst create mode 100644 docs/devel/python/qapi.schema.rst create mode 100644 docs/devel/python/qapi.source.rst create mode 100644 docs/devel/python/qapi.types.rst create mode 100644 docs/devel/python/qapi.visit.rst diff --git a/docs/conf.py b/docs/conf.py index e84a95e71c..4557dbe3e2 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -62,7 +62,8 @@ # Add any Sphinx extension module names here, as strings. They can be # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom # ones. -extensions = ['kerneldoc', 'qmp_lexer', 'hxtool', 'depfile', 'qapidoc'] +extensions = ['kerneldoc', 'qmp_lexer', 'hxtool', + 'depfile', 'qapidoc', 'sphinx.ext.autodoc'] if sphinx.version_info[:3] > (4, 0, 0): tags.add('sphinx4') diff --git a/docs/devel/index.rst b/docs/devel/index.rst index abf60457c2..eff5760177 100644 --- a/docs/devel/index.rst +++ b/docs/devel/index.rst @@ -34,3 +34,4 @@ the :ref:`tcg_internals`. index-api index-internals index-tcg + python/index diff --git a/docs/devel/python/index.rst b/docs/devel/python/index.rst new file mode 100644 index 0000000000..31c470154b --- /dev/null +++ b/docs/devel/python/index.rst @@ -0,0 +1,7 @@ +qapi +==== + +.. toctree:: + :maxdepth: 4 + + qapi diff --git a/docs/devel/python/qapi.commands.rst b/docs/devel/python/qapi.commands.rst new file mode 100644 index 0000000000..018f7b08a9 --- /dev/null +++ b/docs/devel/python/qapi.commands.rst @@ -0,0 +1,7 @@ +qapi.commands module +==================== + +.. automodule:: qapi.commands + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/devel/python/qapi.common.rst b/docs/devel/python/qapi.common.rst new file mode 100644 index 0000000000..128a90d74b --- /dev/null +++ b/docs/devel/python/qapi.common.rst @@ -0,0 +1,7 @@ +qapi.common module +================== + +.. automodule:: qapi.common + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/devel/python/qapi.error.rst b/docs/devel/python/qapi.error.rst new file mode 100644 index 0000000000..980e32b63d --- /dev/null +++ b/docs/devel/python/qapi.error.rst @@ -0,0 +1,7 @@ +qapi.error module +================= + +.. automodule:: qapi.error + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/devel/python/qapi.events.rst b/docs/devel/python/qapi.events.rst new file mode 100644 index 0000000000..1fce85b044 --- /dev/null +++ b/docs/devel/python/qapi.events.rst @@ -0,0 +1,7 @@ +qapi.events module +================== + +.. automodule:: qapi.events + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/devel/python/qapi.expr.rst b/docs/devel/python/qapi.expr.rst new file mode 100644 index 0000000000..0660270629 --- /dev/null +++ b/docs/devel/python/qapi.expr.rst @@ -0,0 +1,7 @@ +qapi.expr module +================ + +.. automodule:: qapi.expr + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/devel/python/qapi.gen.rst b/docs/devel/python/qapi.gen.rst new file mode 100644 index 0000000000..7b495fd4bf --- /dev/null +++ b/docs/devel/python/qapi.gen.rst @@ -0,0 +1,7 @@ +qapi.gen module +=============== + +.. automodule:: qapi.gen + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/devel/python/qapi.introspect.rst b/docs/devel/python/qapi.introspect.rst new file mode 100644 index 0000000000..f65ebfccd1 --- /dev/null +++ b/docs/devel/python/qapi.introspect.rst @@ -0,0 +1,7 @@ +qapi.introspect module +====================== + +.. automodule:: qapi.introspect + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/devel/python/qapi.main.rst b/docs/devel/python/qapi.main.rst new file mode 100644 index 0000000000..1255fcda63 --- /dev/null +++ b/docs/devel/python/qapi.main.rst @@ -0,0 +1,7 @@ +qapi.main module +================ + +.. automodule:: qapi.main + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/devel/python/qapi.parser.rst b/docs/devel/python/qapi.parser.rst new file mode 100644 index 0000000000..1a8f7b347e --- /dev/null +++ b/docs/devel/python/qapi.parser.rst @@ -0,0 +1,8 @@ +qapi.parser module +================== + +.. automodule:: qapi.parser + :members: + :undoc-members: + :show-inheritance: + :private-members: diff --git a/docs/devel/python/qapi.rst b/docs/devel/python/qapi.rst new file mode 100644 index 0000000000..c762019aad --- /dev/null +++ b/docs/devel/python/qapi.rst @@ -0,0 +1,26 @@ +qapi package +============ + +.. automodule:: qapi + :members: + :undoc-members: + :show-inheritance: + +Submodules +---------- + +.. toctree:: + + qapi.commands + qapi.common + qapi.error + qapi.events + qapi.expr + qapi.gen + qapi.introspect + qapi.main + qapi.parser + qapi.schema + qapi.source + qapi.types + qapi.visit diff --git a/docs/devel/python/qapi.schema.rst b/docs/devel/python/qapi.schema.rst new file mode 100644 index 0000000000..a08f75ed72 --- /dev/null +++ b/docs/devel/python/qapi.schema.rst @@ -0,0 +1,7 @@ +qapi.schema module +================== + +.. automodule:: qapi.schema + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/devel/python/qapi.source.rst b/docs/devel/python/qapi.source.rst new file mode 100644 index 0000000000..e61e9f6021 --- /dev/null +++ b/docs/devel/python/qapi.source.rst @@ -0,0 +1,7 @@ +qapi.source module +================== + +.. automodule:: qapi.source + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/devel/python/qapi.types.rst b/docs/devel/python/qapi.types.rst new file mode 100644 index 0000000000..6eea827557 --- /dev/null +++ b/docs/devel/python/qapi.types.rst @@ -0,0 +1,7 @@ +qapi.types module +================= + +.. automodule:: qapi.types + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/devel/python/qapi.visit.rst b/docs/devel/python/qapi.visit.rst new file mode 100644 index 0000000000..84307cbc23 --- /dev/null +++ b/docs/devel/python/qapi.visit.rst @@ -0,0 +1,7 @@ +qapi.visit module +================= + +.. automodule:: qapi.visit + :members: + :undoc-members: + :show-inheritance: