From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mails.dpdk.org (mails.dpdk.org [217.70.189.124]) by inbox.dpdk.org (Postfix) with ESMTP id 15FC743C3F; Thu, 29 Feb 2024 19:12:15 +0100 (CET) Received: from mails.dpdk.org (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id D86B5402ED; Thu, 29 Feb 2024 19:12:14 +0100 (CET) Received: from mail-lj1-f181.google.com (mail-lj1-f181.google.com [209.85.208.181]) by mails.dpdk.org (Postfix) with ESMTP id 8A441402CD for ; Thu, 29 Feb 2024 19:12:13 +0100 (CET) Received: by mail-lj1-f181.google.com with SMTP id 38308e7fff4ca-2d236ae4f45so1310701fa.0 for ; Thu, 29 Feb 2024 10:12:13 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=iol.unh.edu; s=unh-iol; t=1709230332; x=1709835132; darn=dpdk.org; h=content-transfer-encoding:to:subject:message-id:date:from :in-reply-to:references:mime-version:from:to:cc:subject:date :message-id:reply-to; bh=T/mAKSQP97aoZBhudaoruhufghAJ6ZUAJmXjTVrXFKQ=; b=hW0X/4IK3o8JqvJdI1miQVPjixFahkx0gWxfwMlAhTN355fIufTL/uZTjNkp44Dcnz i2XbQpTJ0187WiBSrOT3BvAUIqIp1FadYKCoDHAFsv2d+Qt7+d5GRSU4VLdExI7wB4JQ 9JVIB4+LBrVF4egOjorvrBPZpd8Y1AqKzjCd4= X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1709230332; x=1709835132; h=content-transfer-encoding:to:subject:message-id:date:from :in-reply-to:references:mime-version:x-gm-message-state:from:to:cc :subject:date:message-id:reply-to; bh=T/mAKSQP97aoZBhudaoruhufghAJ6ZUAJmXjTVrXFKQ=; b=krZ1o7Ff0Sqm5QTeQF8uMIlIe+Z8hlR7IGkbf+5ecgpTDAcGnJLuFFqldtW5YUWmVx s0IS1UySpa8MXKCZi8pWzly4o5+/J8ekSE6T16AxvHQTw8GXiDCrOGrjKUdMB+SUW1v+ KpO1hbsYEqWY80ra1Xq7tnoH0wYhGxcTvcAK0lxTipip9M1cix/HfFq8KxNIksm4Veep MwlBHoRycz42/QiT3tE9gkSIYj7CMNC88mqRAuoEYYvWOiLWlP1Oq9fvSN9IedO+yDMQ gsh09CZBWsTJjjiZC3rU3OsNq2yQebSeZv0QDPTIubZsA+65WvHE7ICCOh6GN3BNS+3U np6g== X-Gm-Message-State: AOJu0YyDR/kJQEJNQfjVHwv/qnuq2xRZE9eBbN9wmxNps/eg7DTZSSJv IxSKOk0NbcgntX5CMktFpdLMSz9HRnaYuxh2EZ+0v5wINphOXqByI9g4eTbZnElc4r7j6P7hfSS +1Is92LOCVQer7rUkQR9ZjqKMD/Uo3I6yqYMpiZ+m3/OG67csyb8= X-Google-Smtp-Source: AGHT+IETrivS9rlh1PIfzOrxaAXSpz9ltC4BqrXodIPK5cWaLdTSELi3zNfucg3vHvno9QCbzaKvf1EryQ6mHXTUeXY= X-Received: by 2002:a2e:86c4:0:b0:2d2:246e:b373 with SMTP id n4-20020a2e86c4000000b002d2246eb373mr1814372ljj.5.1709230332348; Thu, 29 Feb 2024 10:12:12 -0800 (PST) MIME-Version: 1.0 References: <20231115133606.42081-1-juraj.linkes@pantheon.tech> <20240122163509.22385-1-juraj.linkes@pantheon.tech> <20240122163509.22385-4-juraj.linkes@pantheon.tech> In-Reply-To: From: Nicholas Pratte Date: Thu, 29 Feb 2024 13:12:01 -0500 Message-ID: Subject: Re: [PATCH v3 3/3] dts: add API doc generation To: dev@dpdk.org, Jeremy Spewock Content-Type: text/plain; charset="UTF-8" Content-Transfer-Encoding: quoted-printable X-BeenThere: dev@dpdk.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: DPDK patches and discussions List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: dev-bounces@dpdk.org Tested-by: Nicholas Pratte ---- The tool used to generate developer docs is Sphinx, which is already in use in DPDK. The same configuration is used to preserve style, but it's been augmented with doc-generating configuration. There's a change that modifies how the sidebar displays the content hierarchy that's been put into an if block to not interfere with regular docs. 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-docstr= ings Signed-off-by: Juraj Linke=C5=A1 --- buildtools/call-sphinx-build.py | 33 +++++++++++++++++++--------- doc/api/doxy-api-index.md | 3 +++ doc/api/doxy-api.conf.in | 2 ++ doc/api/meson.build | 11 +++++++--- doc/guides/conf.py | 39 ++++++++++++++++++++++++++++----- doc/guides/meson.build | 1 + doc/guides/tools/dts.rst | 34 +++++++++++++++++++++++++++- dts/doc/meson.build | 27 +++++++++++++++++++++++ dts/meson.build | 16 ++++++++++++++ meson.build | 1 + 10 files changed, 148 insertions(+), 19 deletions(-) create mode 100644 dts/doc/meson.build create mode 100644 dts/meson.build diff --git a/buildtools/call-sphinx-build.py b/buildtools/call-sphinx-build= .py index 39a60d09fa..aea771a64e 100755 --- a/buildtools/call-sphinx-build.py +++ b/buildtools/call-sphinx-build.py @@ -3,37 +3,50 @@ # Copyright(c) 2019 Intel Corporation # +import argparse import sys import os from os.path import join from subprocess import run, PIPE, STDOUT from packaging.version import Version -# assign parameters to variables -(sphinx, version, src, dst, *extra_args) =3D sys.argv[1:] +parser =3D argparse.ArgumentParser() +parser.add_argument('sphinx') +parser.add_argument('version') +parser.add_argument('src') +parser.add_argument('dst') +parser.add_argument('--dts-root', default=3DNone) +args, extra_args =3D parser.parse_known_args() # set the version in environment for sphinx to pick up -os.environ['DPDK_VERSION'] =3D version +os.environ['DPDK_VERSION'] =3D args.version +if args.dts_root: + os.environ['DTS_ROOT'] =3D args.dts_root # for sphinx version >=3D 1.7 add parallelism using "-j auto" -ver =3D run([sphinx, '--version'], stdout=3DPIPE, +ver =3D run([args.sphinx, '--version'], stdout=3DPIPE, stderr=3DSTDOUT).stdout.decode().split()[-1] -sphinx_cmd =3D [sphinx] + extra_args +sphinx_cmd =3D [args.sphinx] + extra_args if Version(ver) >=3D Version('1.7'): sphinx_cmd +=3D ['-j', 'auto'] # find all the files sphinx will process so we can write them as dependenc= ies srcfiles =3D [] -for root, dirs, files in os.walk(src): +for root, dirs, files in os.walk(args.src): srcfiles.extend([join(root, f) for f in files]) +if not os.path.exists(args.dst): + os.makedirs(args.dst) + # run sphinx, putting the html output in a "html" directory -with open(join(dst, 'sphinx_html.out'), 'w') as out: - process =3D run(sphinx_cmd + ['-b', 'html', src, join(dst, 'html')], - stdout=3Dout) +with open(join(args.dst, 'sphinx_html.out'), 'w') as out: + process =3D run( + sphinx_cmd + ['-b', 'html', args.src, join(args.dst, 'html')], + stdout=3Dout + ) # create a gcc format .d file giving all the dependencies of this doc buil= d -with open(join(dst, '.html.d'), 'w') as d: +with open(join(args.dst, '.html.d'), 'w') as d: d.write('html: ' + ' '.join(srcfiles) + '\n') sys.exit(process.returncode) diff --git a/doc/api/doxy-api-index.md b/doc/api/doxy-api-index.md index a6a768bd7c..b49b24acce 100644 --- a/doc/api/doxy-api-index.md +++ b/doc/api/doxy-api-index.md @@ -241,3 +241,6 @@ The public API headers are grouped by topics: [experimental APIs](@ref rte_compat.h), [ABI versioning](@ref rte_function_versioning.h), [version](@ref rte_version.h) + +- **tests**: + [**DTS**](@dts_api_main_page) diff --git a/doc/api/doxy-api.conf.in b/doc/api/doxy-api.conf.in index e94c9e4e46..d53edeba57 100644 --- a/doc/api/doxy-api.conf.in +++ b/doc/api/doxy-api.conf.in @@ -121,6 +121,8 @@ SEARCHENGINE =3D YES SORT_MEMBER_DOCS =3D NO SOURCE_BROWSER =3D YES +ALIASES =3D "dts_api_main_page=3D@DTS_API_MAIN_PAGE@" + EXAMPLE_PATH =3D @TOPDIR@/examples EXAMPLE_PATTERNS =3D *.c EXAMPLE_RECURSIVE =3D YES diff --git a/doc/api/meson.build b/doc/api/meson.build index 5b50692df9..ffc75d7b5a 100644 --- a/doc/api/meson.build +++ b/doc/api/meson.build @@ -1,6 +1,7 @@ # SPDX-License-Identifier: BSD-3-Clause # Copyright(c) 2018 Luca Boccassi +doc_api_build_dir =3D meson.current_build_dir() doxygen =3D find_program('doxygen', required: get_option('enable_docs')) if not doxygen.found() @@ -32,14 +33,18 @@ example =3D custom_target('examples.dox', # set up common Doxygen configuration cdata =3D configuration_data() cdata.set('VERSION', meson.project_version()) -cdata.set('API_EXAMPLES', join_paths(dpdk_build_root, 'doc', 'api', 'examples.dox')) -cdata.set('OUTPUT', join_paths(dpdk_build_root, 'doc', 'api')) +cdata.set('API_EXAMPLES', join_paths(doc_api_build_dir, 'examples.dox')) +cdata.set('OUTPUT', doc_api_build_dir) cdata.set('TOPDIR', dpdk_source_root) -cdata.set('STRIP_FROM_PATH', ' '.join([dpdk_source_root, join_paths(dpdk_build_root, 'doc', 'api')])) +cdata.set('STRIP_FROM_PATH', ' '.join([dpdk_source_root, doc_api_build_dir= ])) cdata.set('WARN_AS_ERROR', 'NO') if get_option('werror') cdata.set('WARN_AS_ERROR', 'YES') endif +# A local reference must be relative to the main index.html page +# The path below can't be taken from the DTS meson file as that would +# require recursive subdir traversal (doc, dts, then doc again) +cdata.set('DTS_API_MAIN_PAGE', join_paths('..', 'dts', 'html', 'index.html= ')) # configure HTML Doxygen run html_cdata =3D configuration_data() diff --git a/doc/guides/conf.py b/doc/guides/conf.py index 0f7ff5282d..b442a1f76c 100644 --- a/doc/guides/conf.py +++ b/doc/guides/conf.py @@ -7,10 +7,9 @@ from sphinx import __version__ as sphinx_version from os import listdir from os import environ -from os.path import basename -from os.path import dirname +from os.path import basename, dirname from os.path import join as path_join -from sys import argv, stderr +from sys import argv, stderr, path import configparser @@ -24,6 +23,37 @@ file=3Dstderr) pass +# Napoleon enables the Google format of Python doscstrings, used in DTS +# Intersphinx allows linking to external projects, such as Python docs, also used in DTS +extensions =3D ['sphinx.ext.napoleon', 'sphinx.ext.intersphinx'] + +# DTS Python docstring options +autodoc_default_options =3D { + 'members': True, + 'member-order': 'bysource', + 'show-inheritance': True, +} +autodoc_class_signature =3D 'separated' +autodoc_typehints =3D 'both' +autodoc_typehints_format =3D 'short' +autodoc_typehints_description_target =3D 'documented' +napoleon_numpy_docstring =3D False +napoleon_attr_annotations =3D True +napoleon_preprocess_types =3D True +add_module_names =3D False +toc_object_entries =3D True +toc_object_entries_show_parents =3D 'hide' +intersphinx_mapping =3D {'python': ('https://docs.python.org/3', None)} + +dts_root =3D environ.get('DTS_ROOT') +if dts_root: + path.append(dts_root) + # DTS Sidebar config + html_theme_options =3D { + 'collapse_navigation': False, + 'navigation_depth': -1, + } + stop_on_error =3D ('-W' in argv) project =3D 'Data Plane Development Kit' @@ -35,8 +65,7 @@ html_show_copyright =3D False highlight_language =3D 'none' -release =3D environ.setdefault('DPDK_VERSION', "None") -version =3D release +version =3D environ.setdefault('DPDK_VERSION', "None") master_doc =3D 'index' diff --git a/doc/guides/meson.build b/doc/guides/meson.build index 51f81da2e3..8933d75f6b 100644 --- a/doc/guides/meson.build +++ b/doc/guides/meson.build @@ -1,6 +1,7 @@ # SPDX-License-Identifier: BSD-3-Clause # Copyright(c) 2018 Intel Corporation +doc_guides_source_dir =3D meson.current_source_dir() sphinx =3D find_program('sphinx-build', required: get_option('enable_docs'= )) if not sphinx.found() diff --git a/doc/guides/tools/dts.rst b/doc/guides/tools/dts.rst index 846696e14e..21d3d89fc2 100644 --- a/doc/guides/tools/dts.rst +++ b/doc/guides/tools/dts.rst @@ -278,7 +278,12 @@ and try not to divert much from it. The :ref:`DTS developer tools ` will issue warnings when some of the basics are not met. -The code must be properly documented with docstrings. +The API documentation, which is a helpful reference when developing, may be accessed +in the code directly or generated with the :ref:`API docs build steps `. +When adding new files or modifying the directory structure, the corresponding changes must +be made to DTS api doc sources in ``dts/doc``. + +Speaking of which, the code must be properly documented with docstrings. The style must conform to the `Google style `_. See an example of the style `here @@ -413,6 +418,33 @@ the DTS code check and format script. Refer to the script for usage: ``devtools/dts-check-format.sh -h``. +.. _building_api_docs: + +Building DTS API docs +--------------------- + +To build DTS API docs, install the dependencies with Poetry, then enter its shell: + +.. code-block:: console + + poetry install --with docs + poetry shell + +The documentation is built using the standard DPDK build system. After executing the meson command +and entering Poetry's shell, build the documentation with: + +.. code-block:: console + + ninja -C build dts-doc + +The output is generated in ``build/doc/api/dts/html``. + +.. Note:: + + Make sure to fix any Sphinx warnings when adding or updating docstrings. Also make sure to run + the ``devtools/dts-check-format.sh`` script and address any issues it f= inds. + + Configuration Schema -------------------- diff --git a/dts/doc/meson.build b/dts/doc/meson.build new file mode 100644 index 0000000000..01b7b51034 --- /dev/null +++ b/dts/doc/meson.build @@ -0,0 +1,27 @@ +# SPDX-License-Identifier: BSD-3-Clause +# Copyright(c) 2023 PANTHEON.tech s.r.o. + +sphinx =3D find_program('sphinx-build', required: false) +sphinx_apidoc =3D find_program('sphinx-apidoc', required: false) + +if not sphinx.found() or not sphinx_apidoc.found() + subdir_done() +endif + +dts_doc_api_build_dir =3D join_paths(doc_api_build_dir, 'dts') + +extra_sphinx_args =3D ['-E', '-c', doc_guides_source_dir, '--dts-root', dt= s_dir] +if get_option('werror') + extra_sphinx_args +=3D '-W' +endif + +htmldir =3D join_paths(get_option('datadir'), 'doc', 'dpdk', 'dts') +dts_api_html =3D custom_target('dts_api_html', + output: 'html', + command: [sphinx_wrapper, sphinx, meson.project_version(), + meson.current_source_dir(), dts_doc_api_build_dir, extra_sphinx_args], + build_by_default: false, + install: get_option('enable_docs'), + install_dir: htmldir) +doc_targets +=3D dts_api_html +doc_target_names +=3D 'DTS_API_HTML' diff --git a/dts/meson.build b/dts/meson.build new file mode 100644 index 0000000000..e8ce0f06ac --- /dev/null +++ b/dts/meson.build @@ -0,0 +1,16 @@ +# SPDX-License-Identifier: BSD-3-Clause +# Copyright(c) 2023 PANTHEON.tech s.r.o. + +doc_targets =3D [] +doc_target_names =3D [] +dts_dir =3D meson.current_source_dir() + +subdir('doc') + +if doc_targets.length() =3D=3D 0 + message =3D 'No docs targets found' +else + message =3D 'Built docs:' +endif +run_target('dts-doc', command: [echo, message, doc_target_names], + depends: doc_targets) diff --git a/meson.build b/meson.build index 5e161f43e5..001fdcbbbf 100644 --- a/meson.build +++ b/meson.build @@ -87,6 +87,7 @@ subdir('app') # build docs subdir('doc') +subdir('dts') # build any examples explicitly requested - useful for developers - and # install any example code into the appropriate install path -- 2.34.1