toaster-manual: Fix a warning related to the code-block directive

Submitted by Yoann Congal on Jan. 13, 2021, 5:23 p.m. | Patch ID: 179167

Details

Message ID 20210113172329.7683-1-yoann.congal@smile.fr
State New
Headers show

Commit Message

Yoann Congal Jan. 13, 2021, 5:23 p.m.
Fix the following warning by specifying the language (here : shell):
.../yocto/poky/documentation/toaster-manual/reference.rst:572: WARNING: Error in "code-block" directive:
1 argument(s) required, 0 supplied.

.. code-block::

   $ bitbake/lib/toaster/manage.py builddelete build_id

Signed-off-by: Yoann Congal <yoann.congal@smile.fr>
---
 documentation/toaster-manual/reference.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

Patch hide | download patch | download mbox

diff --git a/documentation/toaster-manual/reference.rst b/documentation/toaster-manual/reference.rst
index d2ab14c8e6..135968d40c 100644
--- a/documentation/toaster-manual/reference.rst
+++ b/documentation/toaster-manual/reference.rst
@@ -569,7 +569,7 @@  command would return something like the following::
 The ``builddelete`` command deletes data associated with a build. Access
 the command as follows:
 
-.. code-block::
+.. code-block:: shell
 
    $ bitbake/lib/toaster/manage.py builddelete build_id
 

Comments

Nicolas Dechesne Jan. 13, 2021, 5:39 p.m.
On Wed, Jan 13, 2021 at 6:23 PM Yoann Congal <yoann.congal@smile.fr> wrote:

> Fix the following warning by specifying the language (here : shell):
> .../yocto/poky/documentation/toaster-manual/reference.rst:572: WARNING:
> Error in "code-block" directive:
> 1 argument(s) required, 0 supplied.
>

Which version of Sphinx are you using? I suspect an old version, in Sphinx
2+ (I think) it is no longer an error to omit the language. And I don't see
any warnings in my builds. In fact, we have 0 warning in the whole doc, and
we will try to avoid adding new ones!


>
> .. code-block::
>
>    $ bitbake/lib/toaster/manage.py builddelete build_id
>
> Signed-off-by: Yoann Congal <yoann.congal@smile.fr>
> ---
>  documentation/toaster-manual/reference.rst | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
>
> diff --git a/documentation/toaster-manual/reference.rst
> b/documentation/toaster-manual/reference.rst
> index d2ab14c8e6..135968d40c 100644
> --- a/documentation/toaster-manual/reference.rst
> +++ b/documentation/toaster-manual/reference.rst
> @@ -569,7 +569,7 @@ command would return something like the following::
>  The ``builddelete`` command deletes data associated with a build. Access
>  the command as follows:
>
> -.. code-block::
> +.. code-block:: shell
>
>     $ bitbake/lib/toaster/manage.py builddelete build_id
>
> --
> 2.20.1
>
>
> 
>
>
-=-=-=-=-=-=-=-=-=-=-=-
Links: You receive all messages sent to this group.
View/Reply Online (#832): https://lists.yoctoproject.org/g/docs/message/832
Mute This Topic: https://lists.yoctoproject.org/mt/79656195/3617530
Group Owner: docs+owner@lists.yoctoproject.org
Unsubscribe: https://lists.yoctoproject.org/g/docs/unsub [oe-patchwork@oe-patch.openembedded.org]
-=-=-=-=-=-=-=-=-=-=-=-
Yoann Congal Jan. 14, 2021, 11:06 a.m.
Hi !

Le mer. 13 janv. 2021 à 18:39, Nicolas Dechesne <nicolas.dechesne@linaro.org>
a écrit :

> On Wed, Jan 13, 2021 at 6:23 PM Yoann Congal <yoann.congal@smile.fr>
> wrote:
>
>> Fix the following warning by specifying the language (here : shell):
>> .../yocto/poky/documentation/toaster-manual/reference.rst:572: WARNING:
>> Error in "code-block" directive:
>> 1 argument(s) required, 0 supplied.
>>
>
> Which version of Sphinx are you using? I suspect an old version, in Sphinx
> 2+ (I think) it is no longer an error to omit the language. And I don't see
> any warnings in my builds. In fact, we have 0 warning in the whole doc, and
> we will try to avoid adding new ones!
>

Well you were right! I was running sphinx 1.8. I got no more warnings after
upgrading to sphinx 3.4.3.

Sorry about the noise !


>
>
>>
>> .. code-block::
>>
>>    $ bitbake/lib/toaster/manage.py builddelete build_id
>>
>> Signed-off-by: Yoann Congal <yoann.congal@smile.fr>
>> ---
>>  documentation/toaster-manual/reference.rst | 2 +-
>>  1 file changed, 1 insertion(+), 1 deletion(-)
>>
>> diff --git a/documentation/toaster-manual/reference.rst
>> b/documentation/toaster-manual/reference.rst
>> index d2ab14c8e6..135968d40c 100644
>> --- a/documentation/toaster-manual/reference.rst
>> +++ b/documentation/toaster-manual/reference.rst
>> @@ -569,7 +569,7 @@ command would return something like the following::
>>  The ``builddelete`` command deletes data associated with a build. Access
>>  the command as follows:
>>
>> -.. code-block::
>> +.. code-block:: shell
>>
>>     $ bitbake/lib/toaster/manage.py builddelete build_id
>>
>> --
>> 2.20.1
>>
>>
>> 
>>
>>
Quentin Schulz Jan. 14, 2021, 11:18 a.m.
Hi Yoann, Nicolas,

On Thu, Jan 14, 2021 at 12:06:10PM +0100, Yoann Congal wrote:
> Hi !
> 
> Le mer. 13 janv. 2021 à 18:39, Nicolas Dechesne <nicolas.dechesne@linaro.org>
> a écrit :
> 
> > On Wed, Jan 13, 2021 at 6:23 PM Yoann Congal <yoann.congal@smile.fr>
> > wrote:
> >
> >> Fix the following warning by specifying the language (here : shell):
> >> .../yocto/poky/documentation/toaster-manual/reference.rst:572: WARNING:
> >> Error in "code-block" directive:
> >> 1 argument(s) required, 0 supplied.
> >>
> >
> > Which version of Sphinx are you using? I suspect an old version, in Sphinx
> > 2+ (I think) it is no longer an error to omit the language. And I don't see
> > any warnings in my builds. In fact, we have 0 warning in the whole doc, and
> > we will try to avoid adding new ones!
> >
> 
> Well you were right! I was running sphinx 1.8. I got no more warnings after
> upgrading to sphinx 3.4.3.
> 
> Sorry about the noise !
> 

And now I just discovered we don't have a requirements.txt or something
alike where we could ask for a min version of sphinx.

@Nicolas, any idea why we're not using requirements.txt so that one
could do pip install -r requirements.txt (and we could also enforce a
min version of Sphinx, the theme or pyyaml)? Or whatever mechanisms the
cool kids doing Python use nowadays?

Quentin
-=-=-=-=-=-=-=-=-=-=-=-
Links: You receive all messages sent to this group.
View/Reply Online (#836): https://lists.yoctoproject.org/g/docs/message/836
Mute This Topic: https://lists.yoctoproject.org/mt/79656195/3617530
Group Owner: docs+owner@lists.yoctoproject.org
Unsubscribe: https://lists.yoctoproject.org/g/docs/unsub [oe-patchwork@oe-patch.openembedded.org]
-=-=-=-=-=-=-=-=-=-=-=-
Nicolas Dechesne Jan. 14, 2021, 11:22 a.m.
On Thu, Jan 14, 2021 at 12:18 PM Quentin Schulz <
quentin.schulz@streamunlimited.com> wrote:

> Hi Yoann, Nicolas,
>
> On Thu, Jan 14, 2021 at 12:06:10PM +0100, Yoann Congal wrote:
> > Hi !
> >
> > Le mer. 13 janv. 2021 à 18:39, Nicolas Dechesne <
> nicolas.dechesne@linaro.org>
> > a écrit :
> >
> > > On Wed, Jan 13, 2021 at 6:23 PM Yoann Congal <yoann.congal@smile.fr>
> > > wrote:
> > >
> > >> Fix the following warning by specifying the language (here : shell):
> > >> .../yocto/poky/documentation/toaster-manual/reference.rst:572:
> WARNING:
> > >> Error in "code-block" directive:
> > >> 1 argument(s) required, 0 supplied.
> > >>
> > >
> > > Which version of Sphinx are you using? I suspect an old version, in
> Sphinx
> > > 2+ (I think) it is no longer an error to omit the language. And I
> don't see
> > > any warnings in my builds. In fact, we have 0 warning in the whole
> doc, and
> > > we will try to avoid adding new ones!
> > >
> >
> > Well you were right! I was running sphinx 1.8. I got no more warnings
> after
> > upgrading to sphinx 3.4.3.
> >
> > Sorry about the noise !
> >
>
> And now I just discovered we don't have a requirements.txt or something
> alike where we could ask for a min version of sphinx.
>
> @Nicolas, any idea why we're not using requirements.txt so that one
> could do pip install -r requirements.txt (and we could also enforce a
> min version of Sphinx, the theme or pyyaml)? Or whatever mechanisms the
> cool kids doing Python use nowadays?
>

We have a Pipfile, which is even cooler, no? but we don't specify any
version yet!

>
> Quentin
>
-=-=-=-=-=-=-=-=-=-=-=-
Links: You receive all messages sent to this group.
View/Reply Online (#837): https://lists.yoctoproject.org/g/docs/message/837
Mute This Topic: https://lists.yoctoproject.org/mt/79656195/3617530
Group Owner: docs+owner@lists.yoctoproject.org
Unsubscribe: https://lists.yoctoproject.org/g/docs/unsub [oe-patchwork@oe-patch.openembedded.org]
-=-=-=-=-=-=-=-=-=-=-=-
Quentin Schulz Jan. 14, 2021, 11:46 a.m.
On Thu, Jan 14, 2021 at 12:22:58PM +0100, Nicolas Dechesne wrote:
> On Thu, Jan 14, 2021 at 12:18 PM Quentin Schulz <
> quentin.schulz@streamunlimited.com> wrote:
> 
> > Hi Yoann, Nicolas,
> >
> > On Thu, Jan 14, 2021 at 12:06:10PM +0100, Yoann Congal wrote:
> > > Hi !
> > >
> > > Le mer. 13 janv. 2021 à 18:39, Nicolas Dechesne <
> > nicolas.dechesne@linaro.org>
> > > a écrit :
> > >
> > > > On Wed, Jan 13, 2021 at 6:23 PM Yoann Congal <yoann.congal@smile.fr>
> > > > wrote:
> > > >
> > > >> Fix the following warning by specifying the language (here : shell):
> > > >> .../yocto/poky/documentation/toaster-manual/reference.rst:572:
> > WARNING:
> > > >> Error in "code-block" directive:
> > > >> 1 argument(s) required, 0 supplied.
> > > >>
> > > >
> > > > Which version of Sphinx are you using? I suspect an old version, in
> > Sphinx
> > > > 2+ (I think) it is no longer an error to omit the language. And I
> > don't see
> > > > any warnings in my builds. In fact, we have 0 warning in the whole
> > doc, and
> > > > we will try to avoid adding new ones!
> > > >
> > >
> > > Well you were right! I was running sphinx 1.8. I got no more warnings
> > after
> > > upgrading to sphinx 3.4.3.
> > >
> > > Sorry about the noise !
> > >
> >
> > And now I just discovered we don't have a requirements.txt or something
> > alike where we could ask for a min version of sphinx.
> >
> > @Nicolas, any idea why we're not using requirements.txt so that one
> > could do pip install -r requirements.txt (and we could also enforce a
> > min version of Sphinx, the theme or pyyaml)? Or whatever mechanisms the
> > cool kids doing Python use nowadays?
> >
> 
> We have a Pipfile, which is even cooler, no? but we don't specify any
> version yet!
> 

Didn't even know!

Kind of wary of this project though because of that part of their README:
" WARNING: This project is under active design and development. Nothing
is set in stone at this point in time."

But maybe something we could add to the docs
(https://docs.yoctoproject.org/ref-manual/system-requirements.html) as an
alternative installaion method?

Aaaaaand I should have read the README in yocto-docs more seriously :)

Thanks for the info,
Quentin
-=-=-=-=-=-=-=-=-=-=-=-
Links: You receive all messages sent to this group.
View/Reply Online (#838): https://lists.yoctoproject.org/g/docs/message/838
Mute This Topic: https://lists.yoctoproject.org/mt/79656195/3617530
Group Owner: docs+owner@lists.yoctoproject.org
Unsubscribe: https://lists.yoctoproject.org/g/docs/unsub [oe-patchwork@oe-patch.openembedded.org]
-=-=-=-=-=-=-=-=-=-=-=-
Yoann Congal Jan. 18, 2021, 9:58 a.m.
Hi !



Le jeu. 14 janv. 2021 à 12:46, Quentin Schulz <
quentin.schulz@streamunlimited.com> a écrit :

> On Thu, Jan 14, 2021 at 12:22:58PM +0100, Nicolas Dechesne wrote:
> > On Thu, Jan 14, 2021 at 12:18 PM Quentin Schulz <
> > quentin.schulz@streamunlimited.com> wrote:
> >
> > > Hi Yoann, Nicolas,
> > >
> > > On Thu, Jan 14, 2021 at 12:06:10PM +0100, Yoann Congal wrote:
> > > > Hi !
> > > >
> > > > Le mer. 13 janv. 2021 à 18:39, Nicolas Dechesne <
> > > nicolas.dechesne@linaro.org>
> > > > a écrit :
> > > >
> > > > > On Wed, Jan 13, 2021 at 6:23 PM Yoann Congal <
> yoann.congal@smile.fr>
> > > > > wrote:
> > > > >
> > > > >> Fix the following warning by specifying the language (here :
> shell):
> > > > >> .../yocto/poky/documentation/toaster-manual/reference.rst:572:
> > > WARNING:
> > > > >> Error in "code-block" directive:
> > > > >> 1 argument(s) required, 0 supplied.
> > > > >>
> > > > >
> > > > > Which version of Sphinx are you using? I suspect an old version, in
> > > Sphinx
> > > > > 2+ (I think) it is no longer an error to omit the language. And I
> > > don't see
> > > > > any warnings in my builds. In fact, we have 0 warning in the whole
> > > doc, and
> > > > > we will try to avoid adding new ones!
> > > > >
> > > >
> > > > Well you were right! I was running sphinx 1.8. I got no more warnings
> > > after
> > > > upgrading to sphinx 3.4.3.
> > > >
> > > > Sorry about the noise !
> > > >
> > >
> > > And now I just discovered we don't have a requirements.txt or something
> > > alike where we could ask for a min version of sphinx.
> > >
> > > @Nicolas, any idea why we're not using requirements.txt so that one
> > > could do pip install -r requirements.txt (and we could also enforce a
> > > min version of Sphinx, the theme or pyyaml)? Or whatever mechanisms the
> > > cool kids doing Python use nowadays?
> > >
> >
> > We have a Pipfile, which is even cooler, no? but we don't specify any
> > version yet!
> >
>
> Didn't even know!
>
> Kind of wary of this project though because of that part of their README:
> " WARNING: This project is under active design and development. Nothing
> is set in stone at this point in time."
>
> But maybe something we could add to the docs
> (https://docs.yoctoproject.org/ref-manual/system-requirements.html) as an
> alternative installaion method?
>
> Aaaaaand I should have read the README in yocto-docs more seriously :)
>

Me too!

Following this discussion, I made a proposal here :
https://lists.yoctoproject.org/g/docs/topic/patch_documentation_add_a/79919516
=> A simple Sphinx extension printing a warning on out-dated Sphinx version.
It will prevent this discussion from happening again in the future...

Yoann
-=-=-=-=-=-=-=-=-=-=-=-
Links: You receive all messages sent to this group.
View/Reply Online (#842): https://lists.yoctoproject.org/g/docs/message/842
Mute This Topic: https://lists.yoctoproject.org/mt/79656195/3617530
Group Owner: docs+owner@lists.yoctoproject.org
Unsubscribe: https://lists.yoctoproject.org/g/docs/unsub [oe-patchwork@oe-patch.openembedded.org]
-=-=-=-=-=-=-=-=-=-=-=-