On Mon, Jun 24, 2024 at 03:46:00PM +0200, Juraj Linkeš wrote:
> The tool used to generate DTS API docs is Sphinx, which is already in
> use in DPDK. The same configuration is used to preserve style with one
> DTS-specific configuration (so that the DPDK docs are unchanged) that
> modifies how the sidebar displays the content.
>
> Sphinx generates the documentation from Python docstrings. The docstring
> format is the Google format [0] which requires the sphinx.ext.napoleon
> extension. The other extension, sphinx.ext.intersphinx, enables linking
> to object in external documentations, such as the Python documentation.
>
> There are two requirements for building DTS docs:
> * The same Python version as DTS or higher, because Sphinx imports the
> code.
> * Also the same Python packages as DTS, for the same reason.
>
> [0]
> https://google.github.io/styleguide/pyguide.html#38-comments-and-docstrings
>
> Signed-off-by: Juraj Linkeš <juraj.lin...@pantheon.tech>
> Reviewed-by: Luca Vizzarro <luca.vizza...@arm.com>
> Reviewed-by: Jeremy Spewock <jspew...@iol.unh.edu>
> Tested-by: Luca Vizzarro <luca.vizza...@arm.com>
> Tested-by: Nicholas Pratte <npra...@iol.unh.edu>
> ---
Acked-by: Bruce Richardson <bruce.richard...@intel.com>
