From patchwork Tue Aug 6 15:19:37 2024 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: =?utf-8?q?Juraj_Linke=C5=A1?= X-Patchwork-Id: 142963 X-Patchwork-Delegate: thomas@monjalon.net Return-Path: X-Original-To: patchwork@inbox.dpdk.org Delivered-To: patchwork@inbox.dpdk.org Received: from mails.dpdk.org (mails.dpdk.org [217.70.189.124]) by inbox.dpdk.org (Postfix) with ESMTP id 7B6FE4574E; Tue, 6 Aug 2024 17:20:24 +0200 (CEST) Received: from mails.dpdk.org (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id 2705140A81; Tue, 6 Aug 2024 17:20:06 +0200 (CEST) Received: from mail-lf1-f54.google.com (mail-lf1-f54.google.com [209.85.167.54]) by mails.dpdk.org (Postfix) with ESMTP id 07C7140A77 for ; Tue, 6 Aug 2024 17:20:04 +0200 (CEST) Received: by mail-lf1-f54.google.com with SMTP id 2adb3069b0e04-52f0277daa5so1070676e87.0 for ; Tue, 06 Aug 2024 08:20:03 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=pantheon.tech; s=google; t=1722957603; x=1723562403; darn=dpdk.org; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:from:to:cc:subject:date :message-id:reply-to; bh=DlXaHJz16YTIkhBX7AZHtyiA/CtDsORm8+w9ZVeSZAE=; b=aKt+CIy9bRlJ5xUyxlImcM9omdgvlZvA0ZS9Yb0z+3d77fVRxjha9K9UgBrO6o9rvm IBCWusyw5qjyq9cKA2uTOytz+fhfq3kmNc+a/UvnzxIWWwStW+64dzdIirpRHojsXPNN ANvEOpiZDuemq00wBSxBrXohDMtJeZlLY0dngLK0pw3825pRIbdDd4icrHzeMo4Xe+eb 8pYYvgjjpXU0eEruL0C0pOgYZhgLr1ugvEjKIyiA7zcnkR60M+CPe8HKWr1pxZCvJDaB Gm3x7Qm0qEJoAntKbYo9uy5F729nmupjI9pSstwusspv+qnt0IodJ+ss4P2Guz5V4CRZ Zl3w== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1722957603; x=1723562403; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:x-gm-message-state:from:to:cc :subject:date:message-id:reply-to; bh=DlXaHJz16YTIkhBX7AZHtyiA/CtDsORm8+w9ZVeSZAE=; b=rNqx2cQlrvT12KrQkHkZ14OabmrQydyWGghk16NJfCa6wNI9WNz9azrDoUQU13iDS6 SZeBpbD25jD/X/T/CnFh3FcL1U55Z8bGIrCiJQmDtv5duECrHwxCgS3zU/lWjbSAuLF3 +MA3s4sw2KFAj+ZYcC8WlSn7atBJGKwYb2cfA2XKuAIjOogYJyD39TJixq2/5b690MLj 2v1x1V+/O4TILva3skWPlggE/93v5DNIQeszeBiv5Cv9KG+9GYFm7QuaT7mYUugkYqEn s1s012ZGtsxHmZGYgegCG8VbMWHKm8G9GV6GgkNdhdwpwtF7WgUdg2WsWMa/jFUNjWgf Rg8g== X-Gm-Message-State: AOJu0YwaG+21GHiXO7O/KB2pnEMdIVNEYjpPgGa1cq7I2b6fRABYmTDm 8+jSvsNvT/7yojwR4+ZoRXWX8fbBfr0qioGdWn0DNTQVcoA+GjYxDoy22X3nHHw= X-Google-Smtp-Source: AGHT+IHanVBV3q9RTLvQg/hxhtNMwNg5xh4ucv/d43y+w/yjsV4k9XQcIGhebW6zfMKiZOU+g1LRdg== X-Received: by 2002:a05:6512:1104:b0:52c:df77:6507 with SMTP id 2adb3069b0e04-530bb39b061mr12245962e87.37.1722957585170; Tue, 06 Aug 2024 08:19:45 -0700 (PDT) Received: from jlinkes-PT-Latitude-5530.pantheon.local ([84.245.121.236]) by smtp.gmail.com with ESMTPSA id 4fb4d7f45d1cf-5b83bf3b916sm6094702a12.90.2024.08.06.08.19.44 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Tue, 06 Aug 2024 08:19:44 -0700 (PDT) From: =?utf-8?q?Juraj_Linke=C5=A1?= To: thomas@monjalon.net, Honnappa.Nagarahalli@arm.com, bruce.richardson@intel.com, jspewock@iol.unh.edu, probb@iol.unh.edu, paul.szczepanek@arm.com, Luca.Vizzarro@arm.com, npratte@iol.unh.edu Cc: dev@dpdk.org, =?utf-8?q?Juraj_Linke=C5=A1?= Subject: [PATCH v15 5/5] dts: add API doc generation Date: Tue, 6 Aug 2024 17:19:37 +0200 Message-Id: <20240806151937.391917-6-juraj.linkes@pantheon.tech> X-Mailer: git-send-email 2.34.1 In-Reply-To: <20240806151937.391917-1-juraj.linkes@pantheon.tech> References: <20231115133606.42081-1-juraj.linkes@pantheon.tech> <20240806151937.391917-1-juraj.linkes@pantheon.tech> MIME-Version: 1.0 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 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 objects in external documentations, such as the Python documentation. There is one requirement for building DTS docs - the same Python version as DTS or higher, because Sphinx's autodoc extension imports the code. The dependencies needed to import the code don't have to be satisfied, as the autodoc extension allows us to mock the imports. The missing packages are taken from the DTS pyproject.toml file. [0] https://google.github.io/styleguide/pyguide.html#38-comments-and-docstrings Signed-off-by: Juraj Linkeš --- buildtools/call-sphinx-build.py | 2 + buildtools/get-dts-deps.py | 78 +++++++++++++++++++++++ buildtools/meson.build | 1 + doc/api/doxy-api-index.md | 3 + doc/api/doxy-api.conf.in | 2 + doc/api/dts/custom.css | 1 + doc/api/dts/meson.build | 29 +++++++++ doc/api/meson.build | 13 ++++ doc/guides/conf.py | 41 +++++++++++- doc/guides/contributing/documentation.rst | 2 + doc/guides/contributing/patches.rst | 4 ++ doc/guides/tools/dts.rst | 39 +++++++++++- doc/meson.build | 1 + 13 files changed, 214 insertions(+), 2 deletions(-) create mode 100755 buildtools/get-dts-deps.py create mode 120000 doc/api/dts/custom.css create mode 100644 doc/api/dts/meson.build diff --git a/buildtools/call-sphinx-build.py b/buildtools/call-sphinx-build.py index 623e7363ee..45724ffcd4 100755 --- a/buildtools/call-sphinx-build.py +++ b/buildtools/call-sphinx-build.py @@ -15,6 +15,8 @@ # set the version in environment for sphinx to pick up os.environ['DPDK_VERSION'] = version +if src.find('dts') != -1: + os.environ['DTS_BUILD'] = "y" sphinx_cmd = [sphinx] + extra_args diff --git a/buildtools/get-dts-deps.py b/buildtools/get-dts-deps.py new file mode 100755 index 0000000000..309b83cb5c --- /dev/null +++ b/buildtools/get-dts-deps.py @@ -0,0 +1,78 @@ +#!/usr/bin/env python3 +# SPDX-License-Identifier: BSD-3-Clause +# Copyright(c) 2024 PANTHEON.tech s.r.o. +# + +"""Utilities for DTS dependencies. + +The module can be used as an executable script, +which verifies that the running Python version meets the version requirement of DTS. +The script returns the standard exit codes in this mode (0 is success, 1 is failure). + +The module also contains a function, get_missing_imports, +which looks for runtime and doc generation dependencies in the DTS pyproject.toml file +a returns a list of module names used in an import statement that are missing. +""" + +import configparser +import importlib.metadata +import importlib.util +import os.path +import platform + +_VERSION_COMPARISON_CHARS = '^<>=' +_EXTRA_DEPS = {'invoke': '>=1.3', 'paramiko': '>=2.4'} +_DPDK_ROOT = os.path.dirname(os.path.dirname(__file__)) +_DTS_DEP_FILE_PATH = os.path.join(_DPDK_ROOT, 'dts', 'pyproject.toml') + + +def _get_version_tuple(version_str): + return tuple(map(int, version_str.split("."))) + + +def _get_dependencies(cfg_file_path): + cfg = configparser.ConfigParser() + with open(cfg_file_path) as f: + dts_deps_file_str = f.read() + dts_deps_file_str = dts_deps_file_str.replace("\n]", "]") + cfg.read_string(dts_deps_file_str) + + deps_section = cfg['tool.poetry.dependencies'] + deps = {dep: deps_section[dep].strip('"\'') for dep in deps_section} + doc_deps_section = cfg['tool.poetry.group.docs.dependencies'] + doc_deps = {dep: doc_deps_section[dep].strip("\"'") for dep in doc_deps_section} + + return deps | doc_deps + + +def get_missing_imports(): + missing_imports = [] + req_deps = _get_dependencies(_DTS_DEP_FILE_PATH) + req_deps.pop('python') + + for req_dep, req_ver in (req_deps | _EXTRA_DEPS).items(): + try: + req_ver = _get_version_tuple(req_ver.strip(_VERSION_COMPARISON_CHARS)) + found_dep_ver = _get_version_tuple(importlib.metadata.version(req_dep)) + if found_dep_ver < req_ver: + print( + f'The version "{found_dep_ver}" of package "{req_dep}" ' + f'is lower than required "{req_ver}".' + ) + except importlib.metadata.PackageNotFoundError: + print(f'Package "{req_dep}" not found.') + missing_imports.append(req_dep.lower().replace('-', '_')) + + return missing_imports + + +if __name__ == '__main__': + python_version = _get_dependencies(_DTS_DEP_FILE_PATH).pop('python') + if python_version: + sys_ver = _get_version_tuple(platform.python_version()) + req_ver = _get_version_tuple(python_version.strip(_VERSION_COMPARISON_CHARS)) + if sys_ver < req_ver: + print( + f'The available Python version "{sys_ver}" is lower than required "{req_ver}".' + ) + exit(1) diff --git a/buildtools/meson.build b/buildtools/meson.build index 3adf34e1a8..599653bea4 100644 --- a/buildtools/meson.build +++ b/buildtools/meson.build @@ -24,6 +24,7 @@ get_numa_count_cmd = py3 + files('get-numa-count.py') get_test_suites_cmd = py3 + files('get-test-suites.py') has_hugepages_cmd = py3 + files('has-hugepages.py') cmdline_gen_cmd = py3 + files('dpdk-cmdline-gen.py') +get_dts_deps = py3 + files('get-dts-deps.py') # install any build tools that end-users might want also install_data([ diff --git a/doc/api/doxy-api-index.md b/doc/api/doxy-api-index.md index f9f0300126..ab223bcdf7 100644 --- a/doc/api/doxy-api-index.md +++ b/doc/api/doxy-api-index.md @@ -245,3 +245,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 a8823c046f..c94f02d411 100644 --- a/doc/api/doxy-api.conf.in +++ b/doc/api/doxy-api.conf.in @@ -124,6 +124,8 @@ SEARCHENGINE = YES SORT_MEMBER_DOCS = NO SOURCE_BROWSER = YES +ALIASES = "dts_api_main_page=@DTS_API_MAIN_PAGE@" + EXAMPLE_PATH = @TOPDIR@/examples EXAMPLE_PATTERNS = *.c EXAMPLE_RECURSIVE = YES diff --git a/doc/api/dts/custom.css b/doc/api/dts/custom.css new file mode 120000 index 0000000000..3c9480c4a0 --- /dev/null +++ b/doc/api/dts/custom.css @@ -0,0 +1 @@ +../../guides/custom.css \ No newline at end of file diff --git a/doc/api/dts/meson.build b/doc/api/dts/meson.build new file mode 100644 index 0000000000..329b60cb1f --- /dev/null +++ b/doc/api/dts/meson.build @@ -0,0 +1,29 @@ +# SPDX-License-Identifier: BSD-3-Clause +# Copyright(c) 2023 PANTHEON.tech s.r.o. + +sphinx = find_program('sphinx-build', required: get_option('enable_docs')) +if not sphinx.found() + subdir_done() +endif + +python_ver_satisfied = run_command(get_dts_deps).returncode() +if python_ver_satisfied != 0 + subdir_done() +endif + +extra_sphinx_args = ['-E', '-c', join_paths(doc_source_dir, 'guides')] +if get_option('werror') + extra_sphinx_args += '-W' +endif + +htmldir = join_paths(get_option('datadir'), 'doc', 'dpdk', 'dts') +dts_api_html = custom_target('dts_api_html', + output: 'html', + command: [sphinx_wrapper, sphinx, meson.project_version(), + meson.current_source_dir(), meson.current_build_dir(), extra_sphinx_args], + build_by_default: get_option('enable_docs'), + install: get_option('enable_docs'), + install_dir: htmldir) + +dts_doc_targets += dts_api_html +dts_doc_target_names += 'DTS_API_HTML' diff --git a/doc/api/meson.build b/doc/api/meson.build index 5b50692df9..788129336b 100644 --- a/doc/api/meson.build +++ b/doc/api/meson.build @@ -1,6 +1,18 @@ # SPDX-License-Identifier: BSD-3-Clause # Copyright(c) 2018 Luca Boccassi +dts_doc_targets = [] +dts_doc_target_names = [] +subdir('dts') + +if dts_doc_targets.length() == 0 + dts_message = 'No DTS docs targets found' +else + dts_message = 'Building DTS docs:' +endif +run_target('dts-doc', command: [echo, dts_message, dts_doc_target_names], + depends: dts_doc_targets) + doxygen = find_program('doxygen', required: get_option('enable_docs')) if not doxygen.found() @@ -40,6 +52,7 @@ cdata.set('WARN_AS_ERROR', 'NO') if get_option('werror') cdata.set('WARN_AS_ERROR', 'YES') endif +cdata.set('DTS_API_MAIN_PAGE', join_paths('..', 'dts', 'html', 'index.html')) # configure HTML Doxygen run html_cdata = configuration_data() diff --git a/doc/guides/conf.py b/doc/guides/conf.py index 0f7ff5282d..eab3387874 100644 --- a/doc/guides/conf.py +++ b/doc/guides/conf.py @@ -10,7 +10,7 @@ from os.path import basename from os.path import dirname from os.path import join as path_join -from sys import argv, stderr +from sys import argv, stderr, path import configparser @@ -24,6 +24,45 @@ file=stderr) 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 = ['sphinx.ext.napoleon', 'sphinx.ext.intersphinx'] + +# DTS Python docstring options. +autodoc_default_options = { + 'members': True, + 'member-order': 'bysource', + 'show-inheritance': True, +} +autodoc_class_signature = 'separated' +autodoc_typehints = 'both' +autodoc_typehints_format = 'short' +autodoc_typehints_description_target = 'documented' +napoleon_numpy_docstring = False +napoleon_attr_annotations = True +napoleon_preprocess_types = True +add_module_names = False +toc_object_entries = True +toc_object_entries_show_parents = 'hide' +intersphinx_mapping = {'python': ('https://docs.python.org/3', None)} + +if environ.get('DTS_BUILD'): + # Add path to DTS sources so that Sphinx can find them. + dpdk_root = dirname(dirname(dirname(__file__))) + path.append(path_join(dpdk_root, 'dts')) + + # Get missing DTS dependencies. Add path to buildtools to find the get_missing_imports function. + path.append(path_join(dpdk_root, 'buildtools')) + import importlib + # Ignore missing imports from DTS dependencies. + autodoc_mock_imports = importlib.import_module('get-dts-deps').get_missing_imports() + + # DTS Sidebar config. + html_theme_options = { + 'collapse_navigation': False, + 'navigation_depth': -1, # unlimited depth + } + stop_on_error = ('-W' in argv) project = 'Data Plane Development Kit' diff --git a/doc/guides/contributing/documentation.rst b/doc/guides/contributing/documentation.rst index 68454ae0d5..7b287ce631 100644 --- a/doc/guides/contributing/documentation.rst +++ b/doc/guides/contributing/documentation.rst @@ -133,6 +133,8 @@ added to by the developer. Building the Documentation -------------------------- +.. _doc_dependencies: + Dependencies ~~~~~~~~~~~~ diff --git a/doc/guides/contributing/patches.rst b/doc/guides/contributing/patches.rst index 04c66bebc4..6629928bee 100644 --- a/doc/guides/contributing/patches.rst +++ b/doc/guides/contributing/patches.rst @@ -499,6 +499,10 @@ The script usage is:: For both of the above scripts, the -n option is used to specify a number of commits from HEAD, and the -r option allows the user specify a ``git log`` range. +Additionally, when contributing to the DTS tool, patches should also be checked using +the ``dts-check-format.sh`` script in the ``devtools`` directory of the DPDK repo. +To run the script, extra :ref:`Python dependencies ` are needed. + .. _contrib_check_compilation: Checking Compilation diff --git a/doc/guides/tools/dts.rst b/doc/guides/tools/dts.rst index 515b15e4d8..18cc7908cf 100644 --- a/doc/guides/tools/dts.rst +++ b/doc/guides/tools/dts.rst @@ -54,6 +54,7 @@ DTS uses Poetry as its Python dependency management. Python build/development and runtime environments are the same and DTS development environment, DTS runtime environment or just plain DTS environment are used interchangeably. +.. _dts_deps: Setting up DTS environment ~~~~~~~~~~~~~~~~~~~~~~~~~~ @@ -291,8 +292,15 @@ When adding code to the DTS framework, pay attention to the rest of the code and try not to divert much from it. The :ref:`DTS developer tools ` will issue warnings when some of the basics are not met. +You should also build the :ref:`API documentation ` +to address any issues found during the build. -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 ``doc/api/dts``. + +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 @@ -427,6 +435,35 @@ 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 +--------------------- + +The documentation is built using the standard DPDK build system. +See :doc:`../linux_gsg/build_dpdk` for more details on compiling DPDK with meson. + +The :ref:`doc build dependencies ` may be installed with Poetry: + +.. code-block:: console + + poetry install --no-root --only docs + poetry install --no-root --with docs # an alternative that will also install DTS dependencies + poetry shell + +After executing the meson command, 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. + + Configuration Schema -------------------- diff --git a/doc/meson.build b/doc/meson.build index 6f74706aa2..1e0cfa4127 100644 --- a/doc/meson.build +++ b/doc/meson.build @@ -1,6 +1,7 @@ # SPDX-License-Identifier: BSD-3-Clause # Copyright(c) 2018 Luca Boccassi +doc_source_dir = meson.current_source_dir() doc_targets = [] doc_target_names = [] subdir('api')