On Fri, May 5, 2023 at 4:07 PM Bruce Richardson <bruce.richard...@intel.com> wrote: > > On Thu, May 04, 2023 at 02:37:45PM +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 guide 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. > > > > [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 > > > > I find the requirement to use poetry to build the docs, and the need to run > specific commands in specific directories quite awkward. With this patchset > there is no ability to just turn on the build option for the DTS doc and > have the docs built on the next rebuild. [Also, with every build I've tried > I can't get it to build without warnings about missing "warlock" module.] >
I want to ask about the warnings. This suggests a problem with dependencies, have you entered the Poetry shell? We may need to add some steps to docs, which are currently: poetry install --with docs poetry shell And then: ninja -C build dts/doc Maybe the problem is with Poetry version (1.4.2 and higher should work), which is not specified in the docs yet. I need to update http://patches.dpdk.org/project/dpdk/patch/20230331091355.1224059-1-juraj.lin...@pantheon.tech/ with it. Which are your exact steps for building the docs? Juraj > From what I understand from the patchset, the doc building here using > sphinx is primarily concerned with building the API docs. The rest of DPDK > uses doxygen for this, and since doxygen supports python can the same > tooling be used for the DTS docs? > > /Bruce
