From: Jonathan Corbet <corbet@lwn.net>
To: linux-doc@vger.kernel.org
Cc: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>,
Jani Nikula <jani.nikula@linux.intel.com>,
linux-kernel@vger.kernel.org, Jonathan Corbet <corbet@lwn.net>
Subject: [PATCH v3 0/4] docs: Automatically mark up function references
Date: Wed, 26 Jun 2019 11:28:55 -0600 [thread overview]
Message-ID: <20190626172859.16113-1-corbet@lwn.net> (raw)
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
next reply other threads:[~2019-06-26 17:36 UTC|newest]
Thread overview: 5+ messages / expand[flat|nested] mbox.gz Atom feed top
2019-06-26 17:28 Jonathan Corbet [this message]
2019-06-26 17:28 ` [PATCH v3 1/4] Docs: An initial automarkup extension for sphinx Jonathan Corbet
2019-06-26 17:28 ` [PATCH v3 2/4] docs: remove :c:func: annotations from xarray.rst Jonathan Corbet
2019-06-26 17:28 ` [PATCH v3 3/4] kernel-doc: Don't try to mark up function names Jonathan Corbet
2019-06-26 17:28 ` [PATCH v3 4/4] docs: Note that :c:func: should no longer be used Jonathan Corbet
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20190626172859.16113-1-corbet@lwn.net \
--to=corbet@lwn.net \
--cc=jani.nikula@linux.intel.com \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=mchehab+samsung@kernel.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox