Re: [PATCH] docs: Fix warning:Error in "code-block" directive

From: Randy Dunlap
Date: Fri Jun 02 2023 - 21:41:54 EST




On 6/2/23 18:20, Bagas Sanjaya wrote:
> On Fri, Jun 02, 2023 at 04:51:02PM -0500, Madhumitha Prabakaran wrote:
>> Fix the error in "code-block" directive by providing the
>> argument as "text".
>>
>> <snipped> ...
>> Result code:
>> ------------
>>
>> -.. code-block::
>> +.. code-block:: text
>
> Nope.
>
> I don't see error you mention in this patch when making htmldocs on my
> computer (my setup is pretty standard: see
> Documentation/doc-guide/sphinx.rst). This patch is unneccessary, though,
> unless you have code snippets in some language (e.g. C, where passing
> language name to code-block:: syntax-highlight it). Result code outputs,
> on the other hand, are generic text with no definitive syntax, hence
> you can omit language name.
>
> Thanks.


I also don't see any such warnings so I don't see a need for this patch.
My wild guess is that some older version of Sphinx was being used.

--
~Randy