From patchwork Wed Nov 15 13:36:04 2023 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: 407 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 1BFE443339; Wed, 15 Nov 2023 14:36:10 +0100 (CET) Received: from mails.dpdk.org (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id 0888940294; Wed, 15 Nov 2023 14:36:10 +0100 (CET) Received: from mail-lf1-f54.google.com (mail-lf1-f54.google.com [209.85.167.54]) by mails.dpdk.org (Postfix) with ESMTP id 3073B40285 for ; Wed, 15 Nov 2023 14:36:08 +0100 (CET) Received: by mail-lf1-f54.google.com with SMTP id 2adb3069b0e04-507a29c7eefso9521757e87.1 for ; Wed, 15 Nov 2023 05:36:08 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=pantheon.tech; s=google; t=1700055367; x=1700660167; 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=pBTDWek6gqN/rqzLzs626aB76fgLoQao/EdfXWvnnBQ=; b=VpxYc9BVyssNwuBmdKSLbPxmH/ISo0ZiW466G7grcyzfxzOLsQZJOg6Erm3xfjdpCk 2+wukcooVOdUYQZrfgLl7+febzS8pwfmalkqxBOGd9P+QEPaceexBc2B4gbA2GBctv60 pQL1Xr3HOGLt0VNv41GRWEbtZzRLUfmxEDQ/bVEOxVmkBW/l0ezwa1IvFyoZC4z2oljH b7LJQm5FWhxufvj4pDW8PGQ4cMozeXCpGQ1EJ4x0snqB2+LDRLcrVIrMU/SQi5u7uhlY WGY1doObcB3Q4Hjm1qpiZVJmMt55Uzu0ZckeEILFcjz7/tJYwXvSFDzjhMt+EEEXt9/O XrYw== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1700055367; x=1700660167; 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=pBTDWek6gqN/rqzLzs626aB76fgLoQao/EdfXWvnnBQ=; b=oERV4DvbLbKurcigRrcqeVOWfEW9EhVqMhJ8s8vkyTsBzQPmrHhNIv/WJHNGX/r1tW I7jfhRFlo4HKTOxhiBo3MS2D9RZGmqdW1isKOW8w2XRTlV52GldVxdUxpCgkagSGnFTu TIQV7gvGpKfcKHC+x8yf379vBcPXH0/vaPxhMv36yUShF4EVnMoDZCmS7h/u8F4WWmFP 6OvYGwQSeZy8gRoZXlahP79rU1xbTCj2BwdCXGRWmtVxsWQA2CO4grtbOwE/uJUf/h6G 3ciiz2LbPxs7wxPh7DOHeGqVPz2+OEJpg53vBNLe72zuTby2KTaOU5TQH87pTlmFEPXG XM/w== X-Gm-Message-State: AOJu0Yy/2RtLDWNNF83FKjF3VmvEY9MxyMuqx2VS9BMwFDMCAo5USViA s4tjguUSKqHcn/uSArMyfM0rEA== X-Google-Smtp-Source: AGHT+IGO/Ljf5hEwuFxsHOHl+/QvYLITPvZLvGw/CJ/+y1fuThuSmiL9r6zzACLvV8nOukhYICL5+Q== X-Received: by 2002:a05:6512:1087:b0:509:31c3:288c with SMTP id j7-20020a056512108700b0050931c3288cmr11830735lfg.30.1700055367641; Wed, 15 Nov 2023 05:36:07 -0800 (PST) Received: from jlinkes-PT-Latitude-5530.pantheon.local (81.89.53.154.host.vnet.sk. [81.89.53.154]) by smtp.gmail.com with ESMTPSA id n20-20020a170906b31400b009e656ce2930sm7100749ejz.60.2023.11.15.05.36.06 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Wed, 15 Nov 2023 05:36:07 -0800 (PST) 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, yoan.picchi@foss.arm.com Cc: dev@dpdk.org, =?utf-8?q?Juraj_Linke=C5=A1?= Subject: [PATCH v1 0/2] dts: api docs generation Date: Wed, 15 Nov 2023 14:36:04 +0100 Message-Id: <20231115133606.42081-1-juraj.linkes@pantheon.tech> X-Mailer: git-send-email 2.34.1 In-Reply-To: <20231108125324.191005-23-juraj.linkes@pantheon.tech> References: <20231108125324.191005-23-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 generation is done with Sphinx, which DPDK already uses, with slightly modified configuration (the sidebar: unlimited depth and better collapsing - I need comment on this). 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 dts-doc This patchet depends on the series which updates the DTS docstrings. The technical reason for this dependency is the hash value of the poetry.lock file, which wouldn't match the contents were the patches to be applied individually (the hash value would need to be recomputed after applying the second patch). The logical reason is that there's basically no point in generating the documentation with the configuration in this patch series that's tailored to the google format, which is contained in the depended series. The generation would produce confusing errors and incomplete, not good looking docs. This patch series is much less important that the one updating the docstrings. The docstrings series must be finished and applied as soon as possible, as it has a dramatic impact on future development, while this series doesn't hamper other development in any way. Depends-on: series-30302 ("dts: docstrings update") Juraj Linkeš (2): dts: add doc generation dependencies dts: add doc generation buildtools/call-sphinx-build.py | 29 +- doc/api/meson.build | 1 + doc/guides/conf.py | 34 ++- doc/guides/meson.build | 1 + doc/guides/tools/dts.rst | 32 +- dts/doc/conf_yaml_schema.json | 1 + dts/doc/index.rst | 17 ++ dts/doc/meson.build | 60 ++++ dts/meson.build | 16 + dts/poetry.lock | 499 +++++++++++++++++++++++++++++++- dts/pyproject.toml | 7 + meson.build | 1 + 12 files changed, 681 insertions(+), 17 deletions(-) create mode 120000 dts/doc/conf_yaml_schema.json create mode 100644 dts/doc/index.rst create mode 100644 dts/doc/meson.build create mode 100644 dts/meson.build