From: Jonathan Corbet <corbet@lwn.net>
To: keyrings@vger.kernel.org
Subject: Re: [PATCH 1/2] docs: Standardise capitalisation of section headers in core.rst
Date: Mon, 21 Aug 2017 12:58:16 +0000 [thread overview]
Message-ID: <20170821065816.32c37ef8@lwn.net> (raw)
In-Reply-To: <20170819152106.20432-2-anowlcalledjosh@gmail.com>
On Mon, 21 Aug 2017 12:15:26 +0300
Jani Nikula <jani.nikula@linux.intel.com> wrote:
> However, if you want to sphinxify things a little, you could make the
> resulting html a little bit nicer with automatic links, and document
> maintenance a little bit easier, by replacing the hand written contents
> with:
>
> .. contents::
> :local:
I think this is what we should do. I don't think that manually listing
the section heads buys a whole lot for readers of the docs, and
experience says they won't be kept in sync with the rest of the
document. I'd much rather see a patch taking them out and letting Sphinx
do the work.
Part 2 looks fine, though, I'll apply that shortly.
Thanks,
jon
next prev parent reply other threads:[~2017-08-21 12:58 UTC|newest]
Thread overview: 4+ messages / expand[flat|nested] mbox.gz Atom feed top
2017-08-19 15:21 [PATCH 1/2] docs: Standardise capitalisation of section headers in core.rst Josh Holland
2017-08-21 9:15 ` Jani Nikula
2017-08-21 12:58 ` Jonathan Corbet [this message]
2017-08-23 20:34 ` Josh Holland
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=20170821065816.32c37ef8@lwn.net \
--to=corbet@lwn.net \
--cc=keyrings@vger.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 an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.