From: Randy Dunlap <rdunlap@infradead.org>
To: Linux Documentation <linux-doc@vger.kernel.org>
Subject: confusing ReST/html
Date: Tue, 11 Nov 2025 20:59:25 -0800 [thread overview]
Message-ID: <0fa53fbb-8505-4107-8f1f-4082123fdde6@infradead.org> (raw)
I'm comparing Documentation/core-api/index.{rst,html} and
Documentation/driver-api/index.{rst,html}.
Lots (but not all) .rst files end with something like
.. only:: subproject and html
Indices
=======
* :ref:`genindex`
Both of the core-api & driver-api index.rst files do...
with the difference being that core-api/index.rst has
one space following ".. only::" while driver-api/index.rst
has 2 spaces following ".. only::".
Does that make a difference?
When looking at the end/bottom of core-api/index.html,
there is *NO* heading "Indices" and *NO* link "Index" as there
is in driver-api/index.html.
Why?
There are other cases like this one:
$ cd Documentation; git grep "^\.\. only:: [^ ]"
RCU/index.rst:.. only:: subproject and html
core-api/index.rst:.. only:: subproject and html
rust/index.rst:.. only:: rustdoc and html
rust/index.rst:.. only:: not rustdoc and html
trace/index.rst:.. only:: subproject and html
virt/index.rst:.. only:: html and subproject
wmi/devices/index.rst:.. only:: subproject and html
thanks.
--
~Randy
next reply other threads:[~2025-11-12 4:59 UTC|newest]
Thread overview: 4+ messages / expand[flat|nested] mbox.gz Atom feed top
2025-11-12 4:59 Randy Dunlap [this message]
2025-11-12 9:35 ` confusing ReST/html Mauro Carvalho Chehab
2025-11-12 12:08 ` Jani Nikula
2025-11-12 13:11 ` 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=0fa53fbb-8505-4107-8f1f-4082123fdde6@infradead.org \
--to=rdunlap@infradead.org \
--cc=linux-doc@vger.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