From: Akira Yokosawa <akiyks@gmail.com>
To: Jonathan Corbet <corbet@lwn.net>, linux-doc@vger.kernel.org
Cc: Mauro Carvalho Chehab <mchehab@kernel.org>,
"Maciej W. Rozycki" <macro@orcam.me.uk>,
Miguel Ojeda <ojeda@kernel.org>,
linux-kernel@vger.kernel.org, Akira Yokosawa <akiyks@gmail.com>
Subject: [PATCH 5/5] docs/doc-guide: Put meta title for kernel-doc HTML page
Date: Thu, 9 Jun 2022 22:28:40 +0900 [thread overview]
Message-ID: <15636c13-7fa2-f973-6d3d-361222b839ef@gmail.com> (raw)
In-Reply-To: <dccb5233-7f4f-1be6-d1f4-bbe9f42f88e0@gmail.com>
kernel-doc.rst has two 1st level section titles of "Writing
kernel-doc comments" and "Including kernel-doc comments".
Therefore, rather than using the first one, put a meta title
of "Kernel-doc comments" for the title of the resulting HTML
page by using the "title" directive.
Signed-off-by: Akira Yokosawa <akiyks@gmail.com>
---
Documentation/doc-guide/kernel-doc.rst | 2 ++
1 file changed, 2 insertions(+)
diff --git a/Documentation/doc-guide/kernel-doc.rst b/Documentation/doc-guide/kernel-doc.rst
index a7cb2afd7990..9c779bd7a751 100644
--- a/Documentation/doc-guide/kernel-doc.rst
+++ b/Documentation/doc-guide/kernel-doc.rst
@@ -1,3 +1,5 @@
+.. title:: Kernel-doc comments
+
===========================
Writing kernel-doc comments
===========================
--
2.25.1
next prev parent reply other threads:[~2022-06-09 13:28 UTC|newest]
Thread overview: 15+ messages / expand[flat|nested] mbox.gz Atom feed top
2022-06-09 13:21 [PATCH 0/5] docs/doc-guide: Sphinx related updates Akira Yokosawa
2022-06-09 13:23 ` [PATCH 1/5] docs/doc-guide: Add footnote on Inkscape for better images in PDF documents Akira Yokosawa
2022-06-09 13:24 ` [PATCH 2/5] docs/doc-guide: Mention make variable SPHINXDIRS Akira Yokosawa
2022-06-09 15:26 ` Jonathan Corbet
2022-06-10 1:58 ` Akira Yokosawa
2022-06-09 13:26 ` [RFC PATCH 3/5] docs/doc-guide: Update guidelines for title adornments Akira Yokosawa
2022-06-10 9:11 ` Jani Nikula
2022-06-10 16:08 ` Miguel Ojeda
2022-06-11 3:15 ` Akira Yokosawa
2022-06-11 23:25 ` Mauro Carvalho Chehab
2022-06-09 13:27 ` [RFC PATCH 4/5] docs/doc-guide: Pull guidelines for title adornments out into subsection Akira Yokosawa
2022-06-09 13:28 ` Akira Yokosawa [this message]
2022-06-10 16:50 ` [PATCH 0/5] docs/doc-guide: Sphinx related updates Miguel Ojeda
2022-06-24 19:59 ` Jonathan Corbet
2022-06-24 21:48 ` Akira Yokosawa
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=15636c13-7fa2-f973-6d3d-361222b839ef@gmail.com \
--to=akiyks@gmail.com \
--cc=corbet@lwn.net \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=macro@orcam.me.uk \
--cc=mchehab@kernel.org \
--cc=ojeda@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
all inboxes | Powered by JetHome®