[PATCH v17 5/5] dts: add API doc generation

[Juraj Linkeš]

On 19. 8. 2024 19:53, Dean Marx wrote:
> On Mon, Aug 19, 2024 at 10:37 AM Dean Marx <dmarx at iol.unh.edu 
> <mailto:dmarx at iol.unh.edu>> wrote:
> 
>     I ran into some dependency issues while testing that I figured I'd
>     mention here. My build failed while running meson setup with the
>     -Denable_docs=true option since I didn't have the sphinx-build
>     module installed,

This one is on your end, sphinx is a dependency that must be installed.

>     then my compilation failed while running ninja -C
>     because I didn't have a package called tomli installed. I ran a
>     final time where compilation failed again because my system couldn't
>     find the yaml package.

This, on the other hand, isn't. The build should work without non-sphinx 
dependencies. I'll address these two in the next version. Thanks for 
catching this.

>     It seems like nobody else ran into this so
>     I'm a little confused if it's something on my end, but I tried
>     running the optional poetry install --with docs mentioned in the
>     cover letter and that didn't seem to work either. I was also able to
>     build and compile without -Denable_docs. Thought I'd bring it up
>     because compilation takes a fairly long time, and if a user runs
>     into this I could see it being frustrating.
> 
>     Reviewed-by: Dean Marx <dmarx at iol.unh.edu <mailto:dmarx at iol.unh.edu>>
> 
> 
> Just worked this out with Jeremy, I was running the poetry install 
> --with docs in the DPDK directory instead of the DTS subdirectory. 
> However, while that fixes almost everything, the yaml module is never 
> imported

Does this happen after running poetry install? Pyyaml is in poetry 
dependencies, so this shouldn't be a problem.

But in any case, both builds (either with -Denable_docs=true or with the 
ninja build target ("doc")) should work without installing DTS runtime 
dependencies (the doc build dependencies are still needed). I'm going to 
try building in a fresh environment to test this more thoroughly.

> and was throwing errors for me until I installed pyyaml 
> manually, so this might have been missed in the dependency list