Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-9.6 required=3.0 tests=BAYES_00,DKIM_INVALID, DKIM_SIGNED,HEADER_FROM_DIFFERENT_DOMAINS,INCLUDES_PATCH,MAILING_LIST_MULTI, SIGNED_OFF_BY,SPF_HELO_NONE,SPF_PASS,URIBL_BLOCKED autolearn=ham autolearn_force=no version=3.4.0 Received: from mail.kernel.org (mail.kernel.org [198.145.29.99]) by smtp.lore.kernel.org (Postfix) with ESMTP id 9A720C43461 for ; Thu, 17 Sep 2020 19:16:25 +0000 (UTC) Received: from lists.gnu.org (lists.gnu.org [209.51.188.17]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by mail.kernel.org (Postfix) with ESMTPS id 04EEC206C9 for ; Thu, 17 Sep 2020 19:16:24 +0000 (UTC) Authentication-Results: mail.kernel.org; dkim=fail reason="signature verification failed" (1024-bit key) header.d=redhat.com header.i=@redhat.com header.b="PJupoSVb" DMARC-Filter: OpenDMARC Filter v1.3.2 mail.kernel.org 04EEC206C9 Authentication-Results: mail.kernel.org; dmarc=fail (p=none dis=none) header.from=redhat.com Authentication-Results: mail.kernel.org; spf=pass smtp.mailfrom=qemu-devel-bounces+qemu-devel=archiver.kernel.org@nongnu.org Received: from localhost ([::1]:52934 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1kIzOJ-0007fo-Up for qemu-devel@archiver.kernel.org; Thu, 17 Sep 2020 15:16:23 -0400 Received: from eggs.gnu.org ([2001:470:142:3::10]:48194) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1kIzN9-00077W-KC for qemu-devel@nongnu.org; Thu, 17 Sep 2020 15:15:11 -0400 Received: from us-smtp-1.mimecast.com ([205.139.110.61]:27750 helo=us-smtp-delivery-1.mimecast.com) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_CBC_SHA1:256) (Exim 4.90_1) (envelope-from ) id 1kIzN7-0000Jr-0Q for qemu-devel@nongnu.org; Thu, 17 Sep 2020 15:15:11 -0400 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1600370107; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:cc:mime-version:mime-version:content-type:content-type: in-reply-to:in-reply-to:references:references; bh=UpOmyYB+WtJ57QZRUjrWYdXgicI0AGeXqx+4cDqACwA=; b=PJupoSVbEA7e6yRNiW5a0dhK+mUi/7+dYihp8S+eowYdujE3GE8/3MVYHQCf6rHjniyLRs u5jKgtrR79EdVyVzpH8SLrqXAh5+PmKdkEr3bYU2PiQGxBsZcSLoOatQ+/B2zA8gvq77qt /huoUO4Ra+DrnX91V8qJVN9HhW9bP0A= Received: from mimecast-mx01.redhat.com (mimecast-mx01.redhat.com [209.132.183.4]) (Using TLS) by relay.mimecast.com with ESMTP id us-mta-268-NzLSUYfqNM-wpA3EDAJ_CQ-1; Thu, 17 Sep 2020 15:15:04 -0400 X-MC-Unique: NzLSUYfqNM-wpA3EDAJ_CQ-1 Received: from smtp.corp.redhat.com (int-mx06.intmail.prod.int.phx2.redhat.com [10.5.11.16]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mimecast-mx01.redhat.com (Postfix) with ESMTPS id 2B82064085; Thu, 17 Sep 2020 19:15:03 +0000 (UTC) Received: from localhost (ovpn-119-217.rdu2.redhat.com [10.10.119.217]) by smtp.corp.redhat.com (Postfix) with ESMTP id ABCE36886C; Thu, 17 Sep 2020 19:15:02 +0000 (UTC) Date: Thu, 17 Sep 2020 15:14:55 -0400 From: Eduardo Habkost To: John Snow Subject: Re: [PATCH 14/37] qapi/common.py: Move comments into docstrings Message-ID: <20200917191455.GX7594@habkost.net> References: <20200915224027.2529813-1-jsnow@redhat.com> <20200915224027.2529813-15-jsnow@redhat.com> <87d02kpizr.fsf@dusky.pond.sub.org> <49e28f59-012c-9b7b-02b7-1854f85884b2@redhat.com> MIME-Version: 1.0 In-Reply-To: <49e28f59-012c-9b7b-02b7-1854f85884b2@redhat.com> X-Scanned-By: MIMEDefang 2.79 on 10.5.11.16 Authentication-Results: relay.mimecast.com; auth=pass smtp.auth=CUSA124A263 smtp.mailfrom=ehabkost@redhat.com X-Mimecast-Spam-Score: 0 X-Mimecast-Originator: redhat.com Content-Type: text/plain; charset=utf-8 Content-Disposition: inline Received-SPF: pass client-ip=205.139.110.61; envelope-from=ehabkost@redhat.com; helo=us-smtp-delivery-1.mimecast.com X-detected-operating-system: by eggs.gnu.org: First seen = 2020/09/17 08:56:18 X-ACL-Warn: Detected OS = Linux 2.2.x-3.x [generic] [fuzzy] X-Spam_score_int: -50 X-Spam_score: -5.1 X-Spam_bar: ----- X-Spam_report: (-5.1 / 5.0 requ) BAYES_00=-1.9, DKIMWL_WL_HIGH=-2.997, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, DKIM_VALID_EF=-0.1, RCVD_IN_DNSWL_NONE=-0.0001, RCVD_IN_MSPIKE_H2=-0.001, SPF_HELO_NONE=0.001, SPF_PASS=-0.001 autolearn=ham autolearn_force=no X-Spam_action: no action X-BeenThere: qemu-devel@nongnu.org X-Mailman-Version: 2.1.23 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Cc: Peter Maydell , Cleber Rosa , Alex =?utf-8?Q?Benn=C3=A9e?= , Markus Armbruster , qemu-devel@nongnu.org Errors-To: qemu-devel-bounces+qemu-devel=archiver.kernel.org@nongnu.org Sender: "Qemu-devel" On Thu, Sep 17, 2020 at 02:44:53PM -0400, John Snow wrote: [...] > Having said this, I have not found any tool to date that actually *checks* > these comments for consistency. The pycharm IDE interactively highlights > them when it senses that you have made a mistake, but that cannot be worked > into our CI process that I know of - it's a proprietary checker. > > So right now, they're just plaintext that I am writing to approximate the > Sphinx style until such time as I enable autodoc for the module and > fine-tune the actual formatting and so on. After applying this series, I only had to make two small tweaks to make Sphinx + autodoc happy with the docstrings you wrote. With the following patch, "make sphinxdocs" will generate the QAPI Python module documentation at docs/devel/qapi.html. I had to explicitly skip qapi/doc.py because autodoc thinks the string constants are documentation strings. Signed-off-by: Eduardo Habkost --- docs/conf.py | 5 +++- docs/devel/index.rst | 1 + docs/devel/qapi.rst | 67 ++++++++++++++++++++++++++++++++++++++++++ scripts/qapi/common.py | 2 +- scripts/qapi/gen.py | 2 +- 5 files changed, 74 insertions(+), 3 deletions(-) create mode 100644 docs/devel/qapi.rst diff --git a/docs/conf.py b/docs/conf.py index 8aeac40124..85be0e1860 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -54,6 +54,9 @@ except NameError: # sys.path.insert(0, os.path.join(qemu_docdir, "sphinx")) +# Make scripts/qapi module available for autodoc +sys.path.insert(0, os.path.join(qemu_docdir, "../scripts")) + # -- General configuration ------------------------------------------------ @@ -67,7 +70,7 @@ needs_sphinx = '1.6' # 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'] +extensions = ['kerneldoc', 'qmp_lexer', 'hxtool', 'depfile', 'sphinx.ext.autodoc'] # Add any paths that contain templates here, relative to this directory. templates_path = ['_templates'] diff --git a/docs/devel/index.rst b/docs/devel/index.rst index 04773ce076..a4d2cb9893 100644 --- a/docs/devel/index.rst +++ b/docs/devel/index.rst @@ -31,3 +31,4 @@ Contents: reset s390-dasd-ipl clocks + qapi diff --git a/docs/devel/qapi.rst b/docs/devel/qapi.rst new file mode 100644 index 0000000000..9130ef84c6 --- /dev/null +++ b/docs/devel/qapi.rst @@ -0,0 +1,67 @@ +QAPI Python module reference +============================ + +.. automodule:: qapi + :members: + :undoc-members: + +.. automodule:: qapi.commands + :members: + :undoc-members: + +.. automodule:: qapi.common + :members: + :undoc-members: + +.. automodule:: qapi.debug + :members: + :undoc-members: + +.. automodule:: qapi.error + :members: + :undoc-members: + +.. automodule:: qapi.events + :members: + :undoc-members: + +.. automodule:: qapi.expr + :members: + :undoc-members: + +.. automodule:: qapi.gen + :members: + :undoc-members: + +.. automodule:: qapi.introspect + :members: + :undoc-members: + +.. automodule:: qapi.params + :members: + :undoc-members: + +.. automodule:: qapi.parser + :members: + :undoc-members: + +.. automodule:: qapi.schema + :members: + :undoc-members: + +.. automodule:: qapi.script + :members: + :undoc-members: + +.. automodule:: qapi.source + :members: + :undoc-members: + +.. automodule:: qapi.types + :members: + :undoc-members: + +.. automodule:: qapi.visit + :members: + :undoc-members: + diff --git a/scripts/qapi/common.py b/scripts/qapi/common.py index 0b1af694e6..7c8c4cb846 100644 --- a/scripts/qapi/common.py +++ b/scripts/qapi/common.py @@ -78,7 +78,7 @@ def c_name(name: str, protect: bool = True) -> str: :param name: The name to map. :param protect: If true, avoid returning certain ticklish identifiers - (like C keywords) by prepending 'q_'. + (like C keywords) by prepending ``q_``. """ # ANSI X3J11/88-090, 3.1.1 c89_words = set(['auto', 'break', 'case', 'char', 'const', 'continue', diff --git a/scripts/qapi/gen.py b/scripts/qapi/gen.py index 0a72aecdd0..cf33732256 100644 --- a/scripts/qapi/gen.py +++ b/scripts/qapi/gen.py @@ -161,7 +161,7 @@ def ifcontext(ifcond: List[str], *args: QAPIGenCCode) -> Generator[None, None, None]: """A 'with' statement context manager to wrap with start_if()/end_if() - *args: any number of QAPIGenCCode + :param args: any number of QAPIGenCCode Example:: -- 2.26.2 -- Eduardo