summaryrefslogtreecommitdiff
path: root/Documentation/doc-guide
diff options
context:
space:
mode:
authorBagas Sanjaya <bagasdotme@gmail.com>2022-03-29 07:52:35 +0300
committerJonathan Corbet <corbet@lwn.net>2022-04-05 19:00:43 +0300
commit452c4915c18ce26b08a0e108513e803a196babfd (patch)
tree956ef13b04676ee56fcd0d1495b724854de03464 /Documentation/doc-guide
parent980c3799c5000d1d1d007b1d51b7fb1bb9745a14 (diff)
downloadlinux-452c4915c18ce26b08a0e108513e803a196babfd.tar.xz
Documentation: sphinx: replace "Introduction" chapter heading with page title
Replace first chapter heading ("Introduction") with page title named "Using Sphinx for kernel documentation". This way, the first-level TOC for doc-guide contains title instead of chapter headings for this page. Cc: Jonathan Corbet <corbet@lwn.net> Cc: "David S. Miller" <davem@davemloft.net> Cc: Greg Kroah-Hartman <gregkh@linuxfoundation.org> Cc: Tony Nguyen <anthony.l.nguyen@intel.com> Cc: Vinod Koul <vkoul@kernel.org> Cc: Daniel Borkmann <daniel@iogearbox.net> Cc: Mauro Carvalho Chehab <mchehab+huawei@kernel.org> Cc: Akira Yokosawa <akiyks@gmail.com> Cc: "Rafael J. Wysocki" <rafael.j.wysocki@intel.com> Cc: Jens Axboe <axboe@kernel.dk> Cc: linux-kernel@vger.kernel.org Reviewed-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org> Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Diffstat (limited to 'Documentation/doc-guide')
-rw-r--r--Documentation/doc-guide/sphinx.rst5
1 files changed, 3 insertions, 2 deletions
diff --git a/Documentation/doc-guide/sphinx.rst b/Documentation/doc-guide/sphinx.rst
index bb36f18ae9ac..2ff1ab4158d4 100644
--- a/Documentation/doc-guide/sphinx.rst
+++ b/Documentation/doc-guide/sphinx.rst
@@ -1,7 +1,8 @@
.. _sphinxdoc:
-Introduction
-============
+=====================================
+Using Sphinx for kernel documentation
+=====================================
The Linux kernel uses `Sphinx`_ to generate pretty documentation from
`reStructuredText`_ files under ``Documentation``. To build the documentation in