On Wed, May 17, 2023 at 6:57 PM Bruce Richardson <bruce.richard...@intel.com> wrote: > > On Thu, May 11, 2023 at 11:14:04AM +0200, Juraj Linkeš wrote: > > Augment the meson build system with dts api generation. The api docs are > > generated from Python docstrings in DTS using Sphinx. The format of > > choice is the Google format [0]. > > > > The guides html sphinx configuration is used to preserve the same style. > > > > The build requires the same Python version and dependencies as DTS, > > because Sphinx imports the Python modules. Dependencies are installed > > using Poetry from the dts directory: > > > > poetry install --with docs > > > > After installing, enter the Poetry shell: > > > > poetry shell > > > > And then run the build: > > ninja -C <meson_build_dir> dts/doc > > > > There's only one properly documented module that serves as a > > demonstration of the style - framework.testbed_model.node. When we agree > > on the docstring format, all docstrings will be reformatted. > > > > [0] > > https://google.github.io/styleguide/pyguide.html#s3.8.4-comments-in-classes > > > > Juraj Linkeš (4): > > dts: code adjustments for sphinx > > dts: add doc generation dependencies > > dts: add doc generation > > dts: format docstrigs to google format > > > Given that building the DTS docs requires a special set of commands to set > things up and then to run the build through poetry, I think you should just > drop the option in meson_options.txt. I think it's better if building the > DTS docs is the steps that out outline here, and we don't try and integrate > it into the main DPDK build. >
That makes a lot of sense. I'll make the change. > With that change: > > Series-acked-by: Bruce Richardson <bruce.richard...@intel.com> Thanks.
