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: [RFC PATCH 4/5] docs/doc-guide: Pull guidelines for title adornments out into subsection
Date: Thu, 9 Jun 2022 22:27:27 +0900 [thread overview]
Message-ID: <42600ccb-8cfd-434e-cb4f-f871fd8de708@gmail.com> (raw)
In-Reply-To: <dccb5233-7f4f-1be6-d1f4-bbe9f42f88e0@gmail.com>
As it becomes too large as an item in bullet lists, make it a
subsection of its own.
Signed-off-by: Akira Yokosawa <akiyks@gmail.com>
---
Documentation/doc-guide/sphinx.rst | 29 ++++++++++++++++-------------
1 file changed, 16 insertions(+), 13 deletions(-)
diff --git a/Documentation/doc-guide/sphinx.rst b/Documentation/doc-guide/sphinx.rst
index f257c4785607..f8bbf86fa15a 100644
--- a/Documentation/doc-guide/sphinx.rst
+++ b/Documentation/doc-guide/sphinx.rst
@@ -202,7 +202,16 @@ Here are some specific guidelines for the kernel documentation:
* Also update the content, not just the formatting, when converting
documentation.
-* Please stick to this relative order of section title adornments:
+* For inserting fixed width text blocks (for code examples, use case
+ examples, etc.), use ``::`` for anything that doesn't really benefit
+ from syntax highlighting, especially short snippets. Use
+ ``.. code-block:: <language>`` for longer code blocks that benefit
+ from highlighting. For a short snippet of code embedded in the text, use \`\`.
+
+Guidelines for title adornments
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Please stick to this relative order of section title adornments:
1. ``=`` with overline for 1st level titles::
@@ -225,12 +234,12 @@ Here are some specific guidelines for the kernel documentation:
4th level title
~~~~~~~~~~~~~~~
- Although RST doesn't mandate a specific order ("Rather than imposing a fixed
- number and order of section title adornment styles, the order enforced will be
- the order as encountered."), having the higher levels the same overall makes
- it easier to follow the documents.
+Although RST doesn't mandate a specific order ("Rather than imposing a fixed
+number and order of section title adornment styles, the order enforced will be
+the order as encountered."), having the higher levels the same overall makes
+it easier to follow the documents.
- .. note::
+.. note::
- It is not easy to tell the levels (chapter, section, etc.) of title
adornments in a particular .rst file. A title that appears first in
a .rst file can be at any level of document, chapter, section, or
@@ -258,7 +267,7 @@ Here are some specific guidelines for the kernel documentation:
.. [#rstdoc] https://docutils.sourceforge.io/docs/ref/rst/restructuredtext.html#document
.. [#rstdirtitle] https://docutils.sourceforge.io/docs/ref/rst/directives.html#metadata-document-title
- .. warning::
+.. warning::
For existing documents, manually updating title adornments just to meet
these guidelines is not recommended. Such changes can be error-prone and
may break section hierarchy without being caught by reviewers. They may
@@ -268,12 +277,6 @@ Here are some specific guidelines for the kernel documentation:
It would be appreciated if adjustment of those adornments could be
automated in some way.
-* For inserting fixed width text blocks (for code examples, use case
- examples, etc.), use ``::`` for anything that doesn't really benefit
- from syntax highlighting, especially short snippets. Use
- ``.. code-block:: <language>`` for longer code blocks that benefit
- from highlighting. For a short snippet of code embedded in the text, use \`\`.
-
the C domain
------------
--
2.25.1
next prev parent reply other threads:[~2022-06-09 13:27 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 ` Akira Yokosawa [this message]
2022-06-09 13:28 ` [PATCH 5/5] docs/doc-guide: Put meta title for kernel-doc HTML page Akira Yokosawa
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=42600ccb-8cfd-434e-cb4f-f871fd8de708@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®