From patchwork Wed Jun 26 17:28:55 2019 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Jonathan Corbet X-Patchwork-Id: 167848 Delivered-To: patch@linaro.org Received: by 2002:a92:4782:0:0:0:0:0 with SMTP id e2csp1228414ilk; Wed, 26 Jun 2019 10:36:00 -0700 (PDT) X-Google-Smtp-Source: APXvYqwbNKERBT5GbTb5F/NqzueQtPF8BBrQ7OTZa+lFgMdXhsEuuyA6Tn1H5KFJ3G/gC4CdAuIt X-Received: by 2002:a17:902:8ec7:: with SMTP id x7mr6719008plo.224.1561570560467; Wed, 26 Jun 2019 10:36:00 -0700 (PDT) ARC-Seal: i=1; a=rsa-sha256; t=1561570560; cv=none; d=google.com; s=arc-20160816; b=yIjrbRVEvO0blXkeyrdmGE4pI8UCEqkz1AXtK0dVuh/OFO/qWEm1rT7lsmcwb2jBAj v9NCrkxdY0WseNDjyVEWKilFil7oAJICrbJiWOuIPmmPkWAj4560bbVm+Ozy1nRy2gTb O27p5441izrjFi4TH2/I1ofUP+x3Kue8wBOXTDse3YenAr2XUkPo1OT1C7HlHbmUz3MB VbgNc2O6KuqMhKQ4/zNGzMTbotdk+uzfqdIdU6d1xDW59e2LvIDyUL6s70l+lHz4zDZU Q0P21mzWBLXbSFqd8jZeqajz7L+TqN3zdhNJecIMqtA+dEtzhFCH79iHKYYAfY56kegk Fe0g== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=list-id:precedence:sender:content-transfer-encoding:mime-version :message-id:date:subject:cc:to:from; bh=dWXu9eacBOvUAMqG7jTy9nwj66Y72NrbGGME/JYC9Zg=; b=Lp692r0iwBxxBYBHUZJXmqp4sBeNxKGaSmyM+jzfvRob3X9ep7CRwk6ZLiZ9ACjda3 cq0TOQOQfrdWwRDH7FJYWngVOVMmoDgNMImImHgmxpdsRaj7AKnAokJ/OTAOj0cy+f0f V0DRrV2ha47ca6xIjUqUD2PA5wAAENEzXz0548sis0P92KC6rlQir6Y8xiuV8w2IfEMQ YpkhlHf5rV+4JO3SpztPuESivMC5kjopsPhO+Xzpq3A4fDekk03cBkZ9WIhoHMZviIM3 SH0aJ4Y61KRCj0VEpxtr4ytuE4zB8yt0R/vsXdof8g/nKBav4zUxFEVa0mS4cQyJVGIx 7H0A== ARC-Authentication-Results: i=1; mx.google.com; spf=pass (google.com: best guess record for domain of linux-kernel-owner@vger.kernel.org designates 209.132.180.67 as permitted sender) smtp.mailfrom=linux-kernel-owner@vger.kernel.org Return-Path: Received: from vger.kernel.org (vger.kernel.org. [209.132.180.67]) by mx.google.com with ESMTP id x5si2709747pjp.75.2019.06.26.10.36.00; Wed, 26 Jun 2019 10:36:00 -0700 (PDT) Received-SPF: pass (google.com: best guess record for domain of linux-kernel-owner@vger.kernel.org designates 209.132.180.67 as permitted sender) client-ip=209.132.180.67; Authentication-Results: mx.google.com; spf=pass (google.com: best guess record for domain of linux-kernel-owner@vger.kernel.org designates 209.132.180.67 as permitted sender) smtp.mailfrom=linux-kernel-owner@vger.kernel.org Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1726595AbfFZRf7 (ORCPT + 30 others); Wed, 26 Jun 2019 13:35:59 -0400 Received: from ms.lwn.net ([45.79.88.28]:40904 "EHLO ms.lwn.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1726487AbfFZRf4 (ORCPT ); Wed, 26 Jun 2019 13:35:56 -0400 Received: from meer.lwn.net (localhost [127.0.0.1]) by ms.lwn.net (Postfix) with ESMTPA id 5D1554BF; Wed, 26 Jun 2019 17:29:10 +0000 (UTC) From: Jonathan Corbet To: linux-doc@vger.kernel.org Cc: Mauro Carvalho Chehab , Jani Nikula , linux-kernel@vger.kernel.org, Jonathan Corbet Subject: [PATCH v3 0/4] docs: Automatically mark up function references Date: Wed, 26 Jun 2019 11:28:55 -0600 Message-Id: <20190626172859.16113-1-corbet@lwn.net> X-Mailer: git-send-email 2.21.0 MIME-Version: 1.0 Sender: linux-kernel-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: linux-kernel@vger.kernel.org For the record, I hope that this is the version I will actually merge. It adds an extension to automatically recognize references to functions and create cross references for them, eliminating the need to use the unsightly :c:func:``function`` notation. Since v2 little has happened: - Expand the skip list of system-call names that we shouldn't even try to mark up. - Improve the comments in the extension code slightly - Add a paragraph to the doc-guide discouraging use of :c:func: Jonathan Corbet (4): Docs: An initial automarkup extension for sphinx docs: remove :c:func: annotations from xarray.rst kernel-doc: Don't try to mark up function names docs: Note that :c:func: should no longer be used Documentation/conf.py | 3 +- Documentation/core-api/xarray.rst | 270 ++++++++++++++--------------- Documentation/doc-guide/sphinx.rst | 13 +- Documentation/sphinx/automarkup.py | 93 ++++++++++ scripts/kernel-doc | 2 +- 5 files changed, 239 insertions(+), 142 deletions(-) create mode 100644 Documentation/sphinx/automarkup.py -- 2.21.0