From: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
To: Linux Doc Mailing List <linux-doc@vger.kernel.org>,
Jonathan Corbet <corbet@lwn.net>
Cc: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>,
linux-kernel@vger.kernel.org,
Hans Verkuil <hverkuil-cisco@xs4all.nl>,
Mauro Carvalho Chehab <mchehab@kernel.org>,
linux-media@vger.kernel.org
Subject: [PATCH 0/2] Start supporting builds with Sphinx 3.1+
Date: Thu, 24 Sep 2020 13:22:03 +0200 [thread overview]
Message-ID: <cover.1600945712.git.mchehab+huawei@kernel.org> (raw)
In-Reply-To: <20200924090230.6f3b0ca1@coco.lan>
Hi Jon,
This is a small patch series with just two patches.
The first one adds support at cdomain.py for two notations found on
Sphinx 3.1:
:c:expr:
.. c:namespace::
With that, it should now be possible to use those two C domain
tags at the media documentation, which will make it produce a
decent result with both Sphinx 1.x/2.x and Sphinx 3.1+.
The second patch manually changes the CEC documentation in
order for it to use those macros, instead of relying at the original
cdomain extensions.
I tested building the docs with both Sphinx 2.4.4 and 3.2.1.
They are identical, except by a minor difference: the output of
:c:expr: uses a bold monospaced font with 3.1+, while it uses a
non-bold monospaced font with older versions.
Yet, the output looks decent on both versions.
I'm planning to use the same approach on all the other documents
under userspace-api/media. So, I guess it would be easier if
I could merge both the cdomain.py and the media patches via
the media tree, if this is ok for you.
-
With regards to patch 1, I tried first to use a hook at 'doctree-resolved',
just like the automarkup.py, but that is too late for changing the
namespace. So, I ended hooking the extra logic at 'source-read'.
I suspect that this could be implemented on some other ways, but
this can be optimized later on, if needed.
Mauro Carvalho Chehab (2):
docs: cdomain.py: add support for two new Sphinx 3.1+ tags
media: docs: make CEC documents compatible with Sphinx 3.1+
Documentation/sphinx/cdomain.py | 56 ++++++++++++++++++-
.../media/cec/cec-func-close.rst | 7 ++-
.../media/cec/cec-func-ioctl.rst | 7 ++-
.../userspace-api/media/cec/cec-func-open.rst | 7 ++-
.../userspace-api/media/cec/cec-func-poll.rst | 11 ++--
.../media/cec/cec-ioc-adap-g-caps.rst | 9 ++-
.../media/cec/cec-ioc-adap-g-conn-info.rst | 11 ++--
.../media/cec/cec-ioc-adap-g-log-addrs.rst | 14 +++--
.../media/cec/cec-ioc-adap-g-phys-addr.rst | 14 +++--
.../media/cec/cec-ioc-dqevent.rst | 9 ++-
.../media/cec/cec-ioc-g-mode.rst | 14 +++--
.../media/cec/cec-ioc-receive.rst | 14 +++--
12 files changed, 128 insertions(+), 45 deletions(-)
--
2.26.2
next prev parent reply other threads:[~2020-09-24 11:22 UTC|newest]
Thread overview: 17+ messages / expand[flat|nested] mbox.gz Atom feed top
2020-09-04 16:29 [PATCH RFC] Make the docs build "work" with Sphinx 3.x Jonathan Corbet
2020-09-21 22:26 ` Matthew Wilcox
2020-09-22 7:19 ` Mauro Carvalho Chehab
2020-09-22 7:23 ` Jani Nikula
2020-09-22 16:56 ` Jonathan Corbet
2020-09-23 9:01 ` Mauro Carvalho Chehab
2020-09-23 11:53 ` Mauro Carvalho Chehab
2020-09-23 14:02 ` Mauro Carvalho Chehab
2020-09-24 7:02 ` Mauro Carvalho Chehab
2020-09-24 11:22 ` Mauro Carvalho Chehab [this message]
2020-09-24 11:22 ` [PATCH 1/2] docs: cdomain.py: add support for two new Sphinx 3.1+ tags Mauro Carvalho Chehab
2020-09-24 15:43 ` Jonathan Corbet
2020-09-24 16:13 ` Mauro Carvalho Chehab
2020-09-24 16:22 ` Jonathan Corbet
2020-09-25 4:14 ` Mauro Carvalho Chehab
2020-09-24 11:22 ` [PATCH 2/2] media: docs: make CEC documents compatible with Sphinx 3.1+ Mauro Carvalho Chehab
2020-09-24 12:47 ` [PATCH RFC] Make the docs build "work" with Sphinx 3.x Mauro Carvalho Chehab
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=cover.1600945712.git.mchehab+huawei@kernel.org \
--to=mchehab+huawei@kernel.org \
--cc=corbet@lwn.net \
--cc=hverkuil-cisco@xs4all.nl \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=linux-media@vger.kernel.org \
--cc=mchehab@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;
as well as URLs for NNTP newsgroup(s).