Re: [PATCH 1/2] docs: livepatch: convert docs to ReST and rename to *.rst

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

 



On Fri, May 03, 2019 at 04:30:23PM +0200, Petr Mladek wrote:
> From: Mauro Carvalho Chehab <mchehab+samsung@xxxxxxxxxx>
> 
> Convert livepatch documentation to ReST format. The changes
> are mostly trivial, as the documents are already on a good
> shape. Just a few markup changes are needed for Sphinx to
> properly parse the docs.
> 
> The conversion is actually:
>   - add blank lines and identation in order to identify paragraphs;
>   - fix tables markups;
>   - add some lists markups;
>   - mark literal blocks;
>   - The in-file TOC becomes a comment, in order to skip it from the
>     output, as Sphinx already generates an index there.
>   - adjust title markups.
> 
> At its new index.rst, let's add a :orphan: while this is not linked to
> the main index.rst file, in order to avoid build warnings.
> 
> Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@xxxxxxxxxx>
> Signed-off-by: Petr Mladek <pmladek@xxxxxxxx>

Thanks for working on them.  The Output from htmldocs, looks good.

Reviewed-by: Kamalesh Babulal <kamalesh@xxxxxxxxxxxxxxxxxx>

-- 
Kamalesh




[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[Index of Archives]     [Linux Kernel]     [Linux NFS]     [Linux NILFS]     [Linux USB Devel]     [Video for Linux]     [Linux Audio Users]     [Yosemite News]     [Linux SCSI]

  Powered by Linux