[OT] trying to build kas docs, "No module named 'sphinxarg'"

[OT] trying to build kas docs, "No module named 'sphinxarg'"

[Robert P. J. Day]

Given the abudance of Sphinx expertise here, I'm hoping people will
forgive me for a little off-topic querying ... I checked out kas:

  https://github.com/siemens/kas.git

and tried to build the Sphinx docs with:

  $ make html

and got:

Generate kas-container usage documentation
sphinx-build -b html -d _build/doctrees   . _build/html
Running Sphinx v7.4.7
loading translations [en]... done

Extension error:
Could not import extension sphinxarg.ext (exception: No module named
'sphinxarg')
make: *** [Makefile:53: html] Error 2


I've installed python3-configargparse, but no change. Can anyone
suggest what I need to fetch and install? Thank you kindly.

rday

Re: [docs] [OT] trying to build kas docs, "No module named 'sphinxarg'"

[Antonin Godard]

On Wed Jun 25, 2025 at 8:34 PM CEST, Robert P. J. Day wrote:
>
> Given the abudance of Sphinx expertise here, I'm hoping people will
> forgive me for a little off-topic querying ... I checked out kas:
>
>   https://github.com/siemens/kas.git
>
> and tried to build the Sphinx docs with:
>
>   $ make html
>
> and got:
>
> Generate kas-container usage documentation
> sphinx-build -b html -d _build/doctrees   . _build/html
> Running Sphinx v7.4.7
> loading translations [en]... done
>
> Extension error:
> Could not import extension sphinxarg.ext (exception: No module named
> 'sphinxarg')
> make: *** [Makefile:53: html] Error 2
>
>
> I've installed python3-configargparse, but no change. Can anyone
> suggest what I need to fetch and install? Thank you kindly.

You probably just need to install sphinx-argparse.
https://sphinx-argparse.readthedocs.io/en/latest/

Antonin

-- 
Antonin Godard, Bootlin
Embedded Linux and Kernel engineering
https://bootlin.com

Re: [docs] [OT] trying to build kas docs, "No module named 'sphinxarg'"

[Robert P. J. Day]

On Thu, 26 Jun 2025, Antonin Godard wrote:

> On Wed Jun 25, 2025 at 8:34 PM CEST, Robert P. J. Day wrote:
> >
> > Given the abudance of Sphinx expertise here, I'm hoping people will
> > forgive me for a little off-topic querying ... I checked out kas:
> >
> >   https://github.com/siemens/kas.git
> >
> > and tried to build the Sphinx docs with:
> >
> >   $ make html
> >
> > and got:
> >
> > Generate kas-container usage documentation
> > sphinx-build -b html -d _build/doctrees   . _build/html
> > Running Sphinx v7.4.7
> > loading translations [en]... done
> >
> > Extension error:
> > Could not import extension sphinxarg.ext (exception: No module named
> > 'sphinxarg')
> > make: *** [Makefile:53: html] Error 2
> >
> >
> > I've installed python3-configargparse, but no change. Can anyone
> > suggest what I need to fetch and install? Thank you kindly.
>
> You probably just need to install sphinx-argparse.
> https://sphinx-argparse.readthedocs.io/en/latest/

  that's one of the first things i tried yesterday, failed, try it
again this morning, worked just fine. *sigh*.

rday

Re: [docs] [OT] trying to build kas docs, "No module named 'sphinxarg'"

[Gyorgy Sarvari]

On 6/26/25 11:14, Robert P. J. Day via lists.yoctoproject.org wrote:
> On Thu, 26 Jun 2025, Antonin Godard wrote:
>
>> On Wed Jun 25, 2025 at 8:34 PM CEST, Robert P. J. Day wrote:
>>> Given the abudance of Sphinx expertise here, I'm hoping people will
>>> forgive me for a little off-topic querying ... I checked out kas:
>>>
>>>   https://github.com/siemens/kas.git
>>>
>>> and tried to build the Sphinx docs with:
>>>
>>>   $ make html
>>>
>>> and got:
>>>
>>> Generate kas-container usage documentation
>>> sphinx-build -b html -d _build/doctrees   . _build/html
>>> Running Sphinx v7.4.7
>>> loading translations [en]... done
>>>
>>> Extension error:
>>> Could not import extension sphinxarg.ext (exception: No module named
>>> 'sphinxarg')
>>> make: *** [Makefile:53: html] Error 2
>>>
>>>
>>> I've installed python3-configargparse, but no change. Can anyone
>>> suggest what I need to fetch and install? Thank you kindly.
>> You probably just need to install sphinx-argparse.
>> https://sphinx-argparse.readthedocs.io/en/latest/
>   that's one of the first things i tried yesterday, failed, try it
> again this morning, worked just fine. *sigh*.

FWIW there is a requirements.txt in the docs folder that should help
with the dependencies when used like "pip install -r requirements.txt"
(I guess it's too late now, but maybe next time)

> rday
>
> -=-=-=-=-=-=-=-=-=-=-=-
> Links: You receive all messages sent to this group.
> View/Reply Online (#7227): https://lists.yoctoproject.org/g/docs/message/7227
> Mute This Topic: https://lists.yoctoproject.org/mt/113830450/6084445
> Group Owner: docs+owner@lists.yoctoproject.org
> Unsubscribe: https://lists.yoctoproject.org/g/docs/unsub [skandigraun@gmail.com]
> -=-=-=-=-=-=-=-=-=-=-=-
>