Bagas Sanjaya <bagasdotme@xxxxxxxxx> writes: > 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@xxxxxxx> > Cc: "David S. Miller" <davem@xxxxxxxxxxxxx> > Cc: Greg Kroah-Hartman <gregkh@xxxxxxxxxxxxxxxxxxx> > Cc: Mauro Carvalho Chehab <mchehab+huawei@xxxxxxxxxx> > Cc: linux-kernel@xxxxxxxxxxxxxxx > Signed-off-by: Bagas Sanjaya <bagasdotme@xxxxxxxxx> > --- > 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 79aaa55d6bcf2b..de47b20c806acf 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 > =========================== Honestly, I think this is better fixed just by promoting the existing heading up a level. It describes the file nicely, and we don't need two headers there. > diff --git a/Documentation/doc-guide/sphinx.rst b/Documentation/doc-guide/sphinx.rst > index bb36f18ae9ac3e..140507de5a85e0 100644 > --- a/Documentation/doc-guide/sphinx.rst > +++ b/Documentation/doc-guide/sphinx.rst > @@ -1,5 +1,9 @@ > .. _sphinxdoc: > > +============= > +Sphinx Primer > +============= > + > Introduction > ============ Here, perhaps, replace "Introduction" with "Using Sphinx for kernel documentation" or some such and make that the document title? Thanks, jon
