Re: [PATCH v2 0/5] docs: networking: nfc: convert from txt to rst

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

 



On Fri, 22 Nov 2019 08:43:01 +0100, Robert Schwebel wrote:
> Hi,
> 
> here is v2 of the series converting the NFC documentation from txt to
> rst. Thanks to Jonathan and Dave for the input.
> 
> Changes since (implicit) v1:
> 
> * replace code-block by more compact :: syntax
> 
> * really add the rst file to the index

Applied, thanks.

I have a question and potential follow up to ask for, though.

When the NFC doc gets rendered to HTML now, the "The NFC subsystem is
responsible for:" line is highlighted. I believe this always happens
when a list immediately follows an unindented line, in this case:

The NFC subsystem is responsible for:
	- NFC adapters management;
	- Polling for targets;
	- Low-level data exchange;

I've run into this writing my own docs recently, and I wonder what does
the highlight signify? My understanding is that the highlighting is
done because sphinx assumes the line proceeding the list is its
title/heading.

In most cases (like above) it's not really a heading so there should be
an empty line before the list.

Is this correct Jon?



[Index of Archives]     [Kernel Newbies]     [Security]     [Netfilter]     [Bugtraq]     [Linux FS]     [Yosemite Forum]     [MIPS Linux]     [ARM Linux]     [Linux Security]     [Linux RAID]     [Samba]     [Video 4 Linux]     [Device Mapper]     [Linux Resources]

  Powered by Linux