linux-kernel - [PATCH 0/3 v2] docs: function automarkup, now with 80% fewer regexes!

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [thread-next>] [day] [month] [year] [list]

Message-Id: <20190621235159.6992-1-corbet@lwn.net>
Date:   Fri, 21 Jun 2019 17:51:56 -0600
From:   Jonathan Corbet <corbet@....net>
To:     linux-doc@...r.kernel.org
Cc:     Matthew Wilcox <willy@...radead.org>,
        Mauro Carvalho Chehab <mchehab+samsung@...nel.org>,
        Jani Nikula <jani.nikula@...ux.intel.com>,
        linux-kernel@...r.kernel.org, Jonathan Corbet <corbet@....net>
Subject: [PATCH 0/3 v2] docs: function automarkup, now with 80% fewer regexes!

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