From patchwork Fri Jun 21 23:51:56 2019 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Jonathan Corbet X-Patchwork-Id: 167421 Delivered-To: patch@linaro.org Received: by 2002:a92:4782:0:0:0:0:0 with SMTP id e2csp1345543ilk; Fri, 21 Jun 2019 16:52:13 -0700 (PDT) X-Google-Smtp-Source: APXvYqwaPeMbBem1eaM1++eVpQvoB0mv9AG6D0YshUuhX5uuI35fvwvyHOw/ZFa0rRdUMykeHYDe X-Received: by 2002:a63:2a83:: with SMTP id q125mr6040121pgq.102.1561161133359; Fri, 21 Jun 2019 16:52:13 -0700 (PDT) ARC-Seal: i=1; a=rsa-sha256; t=1561161133; cv=none; d=google.com; s=arc-20160816; b=uuK+MKfJzAAPHndg+6goWYDxvaf7ELyN1n7uarpWjs+E5DslKP+40xvWcc++hNpDYz jhhSWh4N5/68m2VPWGl1Ay+hYiFrNlzPA3Cz2fr0GO6zj61NEhFU9/qr4j10qqo8gDJS K7EJ/hIRJm1E3bCLSPc2Pa2pCtDGeC4ePF06rkm9TUZXeWsavdVNnqXnWywrkxM+5ya9 bR4FANPBgDUCpcqJ3jXIJHQBdyxUvtydyT8s3LTF8F5oR4kjgNd/9VRfiXSHfc28Kg4s pjForrhnf24vObEgJH+lzVirWcQ7BOkIIw7tsLDAeD8cqHpsRPOqmGt4zHbR+0ssl7Oj Ow0A== 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=4iPl+jAydOKCNOPno/Y3PyshakqmRc+YRH5nQRIEOaM=; b=Sdi44LEexJudTOmO/rHofKnI8PTx2CMrGyS0oUToWLp1vFu2JVIB3eKlYfwExySHEY eglUSFgOkOP3/nXq+btOnMJRX9oJu7gL6UGfaAfMr0IbX+ubqrSkz7EqfQXcsRHAd3oh Nvv+mKcuiw4HmcprGshofjvpqnxcNrdYGV5ijQCYWQ7yJpJR5WmLuLGezDgQkJT05RoM 7+Iu9+dSilN/u3notQO/Xq0wnYUgxIAagjErdp18uHAk1emhmrLhW9IJ76Gk2c53X55Y CfFNUjNsY24RzgYd38BVKskQlTzd4GUKmHgkGSPmN2f556WyngLShjd64Okh7ux+RFjt 6Frw== 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 o26si3620382pgv.311.2019.06.21.16.52.12; Fri, 21 Jun 2019 16:52:13 -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 S1726190AbfFUXwL (ORCPT + 30 others); Fri, 21 Jun 2019 19:52:11 -0400 Received: from ms.lwn.net ([45.79.88.28]:55280 "EHLO ms.lwn.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1726045AbfFUXwL (ORCPT ); Fri, 21 Jun 2019 19:52:11 -0400 Received: from meer.lwn.net (localhost [127.0.0.1]) by ms.lwn.net (Postfix) with ESMTPA id 71E202C9; Fri, 21 Jun 2019 23:52:10 +0000 (UTC) From: Jonathan Corbet To: linux-doc@vger.kernel.org Cc: Matthew Wilcox , Mauro Carvalho Chehab , Jani Nikula , linux-kernel@vger.kernel.org, Jonathan Corbet Subject: [PATCH 0/3 v2] docs: function automarkup, now with 80% fewer regexes! Date: Fri, 21 Jun 2019 17:51:56 -0600 Message-Id: <20190621235159.6992-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 It took me a loooong time to get back to this, but here's another crack at automatically marking up "function()" so we can get rid of all that unsightly :c:func: gunk in our docs. This time, it's implemented as a pass over the doctree after everything's read and the references resolved, and the result is certainly far more robust than my first attempt. Jonathan Corbet (3): 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 Documentation/conf.py | 3 +- Documentation/core-api/xarray.rst | 270 ++++++++++++++--------------- Documentation/sphinx/automarkup.py | 80 +++++++++ scripts/kernel-doc | 2 +- 4 files changed, 218 insertions(+), 137 deletions(-) create mode 100644 Documentation/sphinx/automarkup.py -- 2.21.0