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 9AD55425E4; Wed, 20 Sep 2023 09:08:51 +0200 (CEST) Received: from mails.dpdk.org (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id 7F90E40A73; Wed, 20 Sep 2023 09:08:51 +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 396294028C for ; Wed, 20 Sep 2023 09:08:49 +0200 (CEST) Received: by mail-ed1-f48.google.com with SMTP id 4fb4d7f45d1cf-530e180ffcbso4147854a12.1 for ; Wed, 20 Sep 2023 00:08:49 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=pantheon.tech; s=google; t=1695193729; x=1695798529; darn=dpdk.org; h=cc:to:subject:message-id:date:from:in-reply-to:references :mime-version:from:to:cc:subject:date:message-id:reply-to; bh=HR6S5OPxiqzin4xMEiOa6kfd2qSqRSR3O+Ud5tjEsr0=; b=s6tqlUnTE5gSog3R9JtWuqiv5Nm8VH1ZrwefRAAExquVsAWfZkFmum8YDhX+y7ieMT IBzMVxqjrPyB8TmyLQBra+2lDt1xtwSiEVqPwBE0OqmSUc5golUC8e6oz/61DeMreCs2 +crUFaQ99bEyfdSdn8rZOV6ioG4UtUMV9RDVgT5d7wtCmY7GpyPIsexceOiJ7t2YJxyq HsyXkNO2EhlbZIcOCKmG/EWqjaZSxtkGen6vx3N+0sl/z/JwjVI610im1sC+rzCJqN1V IC0pNvEJ6LdAsO+THdeYoET7JcmwNwdO8tbchLHMuwu0D1sRn0jyjI0rkl3QD3BgnMmL dfVg== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1695193729; x=1695798529; h=cc: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=HR6S5OPxiqzin4xMEiOa6kfd2qSqRSR3O+Ud5tjEsr0=; b=OZSk6lbjxC4NJ7dZ2jEZ185LoeW1hvA5F6R3aJTNB8JevgcTLQ4JdylQ1ZgCRjLnCa B/OTa/Z6Viv275xpD+oWbmAzvAAjGMQ6yN+xg4zAz8fAYOC+/It1Lazl5z0IbVQZPvMe W1R/CS+ZaqFdtILTuqU7kmTbnfOdjHhTcI88v2tAhYiyNIzVGjmTYPu13iAslu+5Z4Rj QFIX9Vdw5XaJVWJJsfvf7T5qwsEnoHuQZquwFklzt1Nf5XUVqrweteIcZFAsdA+yffWA gLXPmdTm5RYUCu3sGpe0+e+9UonJcTM0ccxma6TsLaO8QT0DcB3vKkFKSUWSeqhtl3w9 4LPw== X-Gm-Message-State: AOJu0YwkazgZuglJwy7ERIHxEa1/0i3f1rNzztRIEsIvgUW3rnDfXGyj a4P08Rwh21QOe9jTPVDlOqAGs/FW7FdXa3XXjjVbBQ== X-Google-Smtp-Source: AGHT+IGcr3etzfnrkZDMjocRqEGHSPD8qb7n5dxEr9WA89kkc5xa1HVcXi242ZjVdLb57ktgfC7FrP7NrKERB8fbF7s= X-Received: by 2002:aa7:da81:0:b0:530:97b5:49ce with SMTP id q1-20020aa7da81000000b0053097b549cemr1425417eds.10.1695193729067; Wed, 20 Sep 2023 00:08:49 -0700 (PDT) MIME-Version: 1.0 References: <20230511091408.236638-1-juraj.linkes@pantheon.tech> <20230831100407.59865-1-juraj.linkes@pantheon.tech> <20230831100407.59865-4-juraj.linkes@pantheon.tech> In-Reply-To: <20230831100407.59865-4-juraj.linkes@pantheon.tech> From: =?UTF-8?Q?Juraj_Linke=C5=A1?= Date: Wed, 20 Sep 2023 09:08:38 +0200 Message-ID: Subject: Re: [RFC PATCH v4 3/4] dts: add doc generation To: thomas@monjalon.net, Honnappa.Nagarahalli@arm.com, lijuan.tu@intel.com, bruce.richardson@intel.com, jspewock@iol.unh.edu, probb@iol.unh.edu Cc: dev@dpdk.org Content-Type: text/plain; charset="UTF-8" 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 > diff --git a/doc/guides/conf.py b/doc/guides/conf.py > index 0f7ff5282d..737e5a5688 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,29 @@ > file=stderr) > pass > > +extensions = ['sphinx.ext.napoleon'] > + > +# Python docstring options > +autodoc_default_options = { > + 'members': True, > + 'member-order': 'bysource', > + 'show-inheritance': True, > +} > +autodoc_typehints = 'both' > +autodoc_typehints_format = 'short' > +napoleon_numpy_docstring = False > +napoleon_attr_annotations = True > +napoleon_use_ivar = True > +napoleon_use_rtype = False > +add_module_names = False > +toc_object_entries = False > + > +# Sidebar config > +html_theme_options = { > + 'collapse_navigation': False, > + 'navigation_depth': -1, > +} > + Thomas, Bruce, I've added this configuration which modifies the sidebar a bit. This affects the DPDK docs so I'd like to know whether this is permissible. I think the sidebar works better this way even with DPDK docs, but that may be a personal preference. Let me know what you think. > stop_on_error = ('-W' in argv) > > project = 'Data Plane Development Kit'