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 48C21457C4; Wed, 14 Aug 2024 17:05:39 +0200 (CEST) Received: from mails.dpdk.org (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id 39507402C4; Wed, 14 Aug 2024 17:05:39 +0200 (CEST) Received: from mail-ed1-f48.google.com (mail-ed1-f48.google.com [209.85.208.48]) by mails.dpdk.org (Postfix) with ESMTP id 09DE240274 for ; Wed, 14 Aug 2024 17:05:38 +0200 (CEST) Received: by mail-ed1-f48.google.com with SMTP id 4fb4d7f45d1cf-5af6a1afa63so50623a12.0 for ; Wed, 14 Aug 2024 08:05:38 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=pantheon.tech; s=google; t=1723647937; x=1724252737; 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=+oxb1/fnD6mNWR0jx4L28TDYtEim7G88kWvDH/zLTGk=; b=n8FAMXiAIYLS/vasFwrYBKsgyHMMj5YFzAMQEU5QYiYy0K+GPmEVope9pYaANHisWp kVNL17Z15TQmlXJPuboDgwQntrLtT0DsOwvHlbugAMwxpqSeDhlpNtHetmVoAemLcj5G 5m0/XvtdBo5AtK3zOQJQeH73wNj1LoL9RLw2enm2ij6K/b8A4VYhXeoHnJBMEfobpOfg bbDlgsr0BEJkqNoBxf8ebtgghg7j8SjS6FZBgNLbBNAHlk1NI55tldwTGOq9VUa7gMtn pRuLxGLos77KRJy3N516YVpNBah8x75+ftlNJtmGRQQnmAedqxdehBC10CDaDvWFk43p AnZg== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1723647937; x=1724252737; 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=+oxb1/fnD6mNWR0jx4L28TDYtEim7G88kWvDH/zLTGk=; b=fAZYczjlvQqNjuyY+dl5p00seUZChZ/nhpImS5Yi/FuSJ/9do3We/4O1jbLFkCJ0q4 BYCP+NOBhkvwEhZZKf54WSZsQNus0WRAXvE5UgR13QaGhI4q7uMwQ3Uhqiz+8ln9AACS yYFIsu08LfduzLZFsJCV4FyQ6d8isu2PmXA96SPwWwd31ELypYLlhQwUBL6AuFGXl4mi xDwpu22pQuy05LBqIwI/HeZ6sLJJlJNXiHL1L7EUZR4WWLAwSPIGXg4WRzJ+O3C19VMA Zr+qvjRgHntO3Pr0Na8rZM6yv3T46nLzJd9L79T4fq9VQc+WcfOj35GteBKBT2Cq+ynl zEvg== X-Gm-Message-State: AOJu0YwUYfbzcHWEmuspiDN2W/3SWTiNiRDNubmkDTwhxLovyMib0DWo e4beJqCEgHQo0g6Knx9wv39O5fAgi7YNIm+kTIT+mPABzw1tVWVAcEYJWqEHbro= X-Google-Smtp-Source: AGHT+IGQlVrIDC/9lcZCfgHvmz6FpLNN9Vw6PXdqnl9XCOVYkaX+sohCEwwuhI5rWZ1wefeBCwlttw== X-Received: by 2002:a05:6402:2354:b0:5bb:b8e1:4653 with SMTP id 4fb4d7f45d1cf-5bea1cac726mr1912341a12.24.1723647937321; Wed, 14 Aug 2024 08:05:37 -0700 (PDT) Received: from jlinkes-PT-Latitude-5530.pantheon.local ([84.245.121.236]) by smtp.gmail.com with ESMTPSA id 4fb4d7f45d1cf-5bd196a7a11sm4009509a12.53.2024.08.14.08.05.36 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Wed, 14 Aug 2024 08:05:36 -0700 (PDT) From: =?UTF-8?q?Juraj=20Linke=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=20Linke=C5=A1?= Subject: [PATCH v17 0/5] API docs generation Date: Wed, 14 Aug 2024 17:05:30 +0200 Message-Id: <20240814150535.239547-1-juraj.linkes@pantheon.tech> X-Mailer: git-send-email 2.34.1 In-Reply-To: <20231115133606.42081-1-juraj.linkes@pantheon.tech> References: <20231115133606.42081-1-juraj.linkes@pantheon.tech> MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit 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 generation is done with Sphinx, which DPDK already uses, with slightly modified configuration of the sidebar present in an if block. DTS dependencies do not need to be installed, but there is the option to install doc build dependencies with Poetry: poetry install --with docs The build itself may be run with: meson setup -Denable_docs=true ninja -C The above will do a full DPDK build with docs. To build just docs: meson setup ninja -C doc Python3.10 is required to build the DTS API docs. The patchset contains the .rst sources which Sphinx uses to generate the html pages. These were first generated with the sphinx-apidoc utility and modified to provide a better look. The documentation just doesn't look that good without the modifications and there isn't enough configuration options to achieve that without manual changes to the .rst files. This introduces extra maintenance which involves adding new .rst files when a new Python module is added or changing the .rst structure if the Python directory/file structure is changed (moved, renamed files). This small maintenance burden is outweighed by the flexibility afforded by the ability to make manual changes to the .rst files. v10: Fix dts doc generation issue: Only copy the custom rss file if it exists. v11: Added the config option autodoc_mock_imports, which eliminates the need for DTS dependencies. Added a script that find out which imports need to be added to autodoc_mock_imports. The script also check the required Python version for building DTS docs. Removed tags from the two affected patches which will need to be reviewed again. v12: Added paramiko to the required dependencies of get-dts-deps.py. v13: Fixed build error: TypeError: unsupported operand type(s) for |: 'NoneType' and 'Transport' v14: Fixed install error: ERROR: File 'dts/doc/html' could not be found This required me to put the built docs into dts/doc which is outside the DPDK API doc dir, resulting in linking between DPDK and DTS api docs not working properly. I addressed this by adding a symlink to the build dir. This way the link works after installing the docs and the symlink is just one extra file in the build dir. v15: Moved DTS API sources to doc/api/dts. This simplifies a lot of things in the build, but mainly makes a lot of sense. Now the source, build and install paths are the same so there isn't any need for any symlinks or other workarounds. Also added a symlink to the custom.css file so that it works with call-sphinx-build.py without any modifications. v16: Renamed the dependency python file to get-dts-runtime-deps.py a modified it to only get runtime dependencies. We don't need to check docs dependencies (Sphinx) as we don't need to mock those. Also moved all new Sphinx configuration into the DTS if branch to make sure it won't ever affect the DPDK doc build. v17: Removed the dts-doc build target to mirror the functionality of using -Denable_docs=true. Moved DTS-specific meson build code to doc/api/dts/meson.build. Added comments to get_missing_imports() and the top level docstring of get-dts-runtime-deps.py to explain the function is there to be imported. Juraj Linkeš (5): dts: update params and parser docstrings dts: replace the or operator in third party types dts: add doc generation dependencies dts: add API doc sources dts: add API doc generation buildtools/call-sphinx-build.py | 2 + buildtools/get-dts-runtime-deps.py | 84 +++ buildtools/meson.build | 1 + doc/api/doxy-api-index.md | 3 + doc/api/doxy-api.conf.in | 2 + doc/api/dts/conf_yaml_schema.json | 1 + doc/api/dts/custom.css | 1 + doc/api/dts/framework.config.rst | 12 + doc/api/dts/framework.config.types.rst | 6 + doc/api/dts/framework.exception.rst | 6 + doc/api/dts/framework.logger.rst | 6 + doc/api/dts/framework.params.eal.rst | 6 + doc/api/dts/framework.params.rst | 14 + doc/api/dts/framework.params.testpmd.rst | 6 + doc/api/dts/framework.params.types.rst | 6 + doc/api/dts/framework.parser.rst | 6 + .../framework.remote_session.dpdk_shell.rst | 6 + ...ote_session.interactive_remote_session.rst | 6 + ...ework.remote_session.interactive_shell.rst | 6 + .../framework.remote_session.python_shell.rst | 6 + ...ramework.remote_session.remote_session.rst | 6 + doc/api/dts/framework.remote_session.rst | 18 + .../framework.remote_session.ssh_session.rst | 6 + ...framework.remote_session.testpmd_shell.rst | 6 + doc/api/dts/framework.runner.rst | 6 + doc/api/dts/framework.settings.rst | 6 + doc/api/dts/framework.test_result.rst | 6 + doc/api/dts/framework.test_suite.rst | 6 + doc/api/dts/framework.testbed_model.cpu.rst | 6 + .../framework.testbed_model.linux_session.rst | 6 + doc/api/dts/framework.testbed_model.node.rst | 6 + .../framework.testbed_model.os_session.rst | 6 + doc/api/dts/framework.testbed_model.port.rst | 6 + .../framework.testbed_model.posix_session.rst | 6 + doc/api/dts/framework.testbed_model.rst | 26 + .../dts/framework.testbed_model.sut_node.rst | 6 + .../dts/framework.testbed_model.tg_node.rst | 6 + ..._generator.capturing_traffic_generator.rst | 6 + ...mework.testbed_model.traffic_generator.rst | 14 + ....testbed_model.traffic_generator.scapy.rst | 6 + ...el.traffic_generator.traffic_generator.rst | 6 + ...framework.testbed_model.virtual_device.rst | 6 + doc/api/dts/framework.utils.rst | 6 + doc/api/dts/index.rst | 43 ++ doc/api/dts/meson.build | 31 ++ doc/api/meson.build | 6 +- doc/guides/conf.py | 44 +- doc/guides/contributing/documentation.rst | 2 + doc/guides/contributing/patches.rst | 4 + doc/guides/tools/dts.rst | 39 +- doc/meson.build | 1 + dts/framework/params/__init__.py | 4 +- dts/framework/params/eal.py | 7 +- dts/framework/params/types.py | 3 +- dts/framework/parser.py | 4 +- .../interactive_remote_session.py | 3 +- dts/poetry.lock | 521 +++++++++++++++++- dts/pyproject.toml | 8 + 58 files changed, 1061 insertions(+), 23 deletions(-) create mode 100755 buildtools/get-dts-runtime-deps.py create mode 120000 doc/api/dts/conf_yaml_schema.json create mode 120000 doc/api/dts/custom.css create mode 100644 doc/api/dts/framework.config.rst create mode 100644 doc/api/dts/framework.config.types.rst create mode 100644 doc/api/dts/framework.exception.rst create mode 100644 doc/api/dts/framework.logger.rst create mode 100644 doc/api/dts/framework.params.eal.rst create mode 100644 doc/api/dts/framework.params.rst create mode 100644 doc/api/dts/framework.params.testpmd.rst create mode 100644 doc/api/dts/framework.params.types.rst create mode 100644 doc/api/dts/framework.parser.rst create mode 100644 doc/api/dts/framework.remote_session.dpdk_shell.rst create mode 100644 doc/api/dts/framework.remote_session.interactive_remote_session.rst create mode 100644 doc/api/dts/framework.remote_session.interactive_shell.rst create mode 100644 doc/api/dts/framework.remote_session.python_shell.rst create mode 100644 doc/api/dts/framework.remote_session.remote_session.rst create mode 100644 doc/api/dts/framework.remote_session.rst create mode 100644 doc/api/dts/framework.remote_session.ssh_session.rst create mode 100644 doc/api/dts/framework.remote_session.testpmd_shell.rst create mode 100644 doc/api/dts/framework.runner.rst create mode 100644 doc/api/dts/framework.settings.rst create mode 100644 doc/api/dts/framework.test_result.rst create mode 100644 doc/api/dts/framework.test_suite.rst create mode 100644 doc/api/dts/framework.testbed_model.cpu.rst create mode 100644 doc/api/dts/framework.testbed_model.linux_session.rst create mode 100644 doc/api/dts/framework.testbed_model.node.rst create mode 100644 doc/api/dts/framework.testbed_model.os_session.rst create mode 100644 doc/api/dts/framework.testbed_model.port.rst create mode 100644 doc/api/dts/framework.testbed_model.posix_session.rst create mode 100644 doc/api/dts/framework.testbed_model.rst create mode 100644 doc/api/dts/framework.testbed_model.sut_node.rst create mode 100644 doc/api/dts/framework.testbed_model.tg_node.rst create mode 100644 doc/api/dts/framework.testbed_model.traffic_generator.capturing_traffic_generator.rst create mode 100644 doc/api/dts/framework.testbed_model.traffic_generator.rst create mode 100644 doc/api/dts/framework.testbed_model.traffic_generator.scapy.rst create mode 100644 doc/api/dts/framework.testbed_model.traffic_generator.traffic_generator.rst create mode 100644 doc/api/dts/framework.testbed_model.virtual_device.rst create mode 100644 doc/api/dts/framework.utils.rst create mode 100644 doc/api/dts/index.rst create mode 100644 doc/api/dts/meson.build -- 2.34.1