lkml.org 
[lkml]   [2022]   [Mar]   [15]   [last100]   RSS Feed
Views: [wrap][no wrap]   [headers]  [forward] 
 
Messages in this thread
Patch in this message
/
From
Subject[PATCH] Documentation: add missing page title for kernel-doc.rst and sphinx.rst
Date
sphinx.rst and kernel-doc.rst are missing page title, thus top-level
headings in the respective documentation is displayed in the table of
contents for doc-guide.

Add the title.

Cc: Jonathan Corbet <corbet@lwn.net>
Cc: "David S. Miller" <davem@davemloft.net>
Cc: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
Cc: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
Cc: linux-kernel@vger.kernel.org
Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com>
---
Documentation/doc-guide/kernel-doc.rst | 4 ++++
Documentation/doc-guide/sphinx.rst | 4 ++++
2 files changed, 8 insertions(+)

diff --git a/Documentation/doc-guide/kernel-doc.rst b/Documentation/doc-guide/kernel-doc.rst
index 79aaa55d6bc..de47b20c806 100644
--- a/Documentation/doc-guide/kernel-doc.rst
+++ b/Documentation/doc-guide/kernel-doc.rst
@@ -1,3 +1,7 @@
+==========================
+kernel-doc Comments Format
+==========================
+
Writing kernel-doc comments
===========================

diff --git a/Documentation/doc-guide/sphinx.rst b/Documentation/doc-guide/sphinx.rst
index bb36f18ae9a..140507de5a8 100644
--- a/Documentation/doc-guide/sphinx.rst
+++ b/Documentation/doc-guide/sphinx.rst
@@ -1,5 +1,9 @@
.. _sphinxdoc:

+=============
+Sphinx Primer
+=============
+
Introduction
============

base-commit: 09688c0166e76ce2fb85e86b9d99be8b0084cdf9
--
An old man doll... just what I always wanted! - Clara

\
 
 \ /
  Last update: 2022-03-15 08:56    [W:0.238 / U:0.060 seconds]
©2003-2020 Jasper Spaans|hosted at Digital Ocean and TransIP|Read the blog|Advertise on this site