Re: [PATCH v2 20/79] docs: livepatch: convert docs to ReST and rename to *.rst

From: Petr Mladek
Date: Fri Apr 26 2019 - 04:11:02 EST


On Mon 2019-04-22 10:27:09, Mauro Carvalho Chehab wrote:
> 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.

Thanks a lot for the conversion.

It made me to review style of all documents. I would like add
the following changes to make them more consistent.

I can added as extra patch or merged with your one.
Whatewer works better for you or documentation people.