From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from out1-smtp.messagingengine.com (out1-smtp.messagingengine.com [66.111.4.25]) by dpdk.org (Postfix) with ESMTP id 01D052BC9 for ; Fri, 4 Aug 2017 12:10:24 +0200 (CEST) Received: from compute1.internal (compute1.nyi.internal [10.202.2.41]) by mailout.nyi.internal (Postfix) with ESMTP id 9E44E208AE; Fri, 4 Aug 2017 06:10:24 -0400 (EDT) Received: from frontend2 ([10.202.2.161]) by compute1.internal (MEProxy); Fri, 04 Aug 2017 06:10:24 -0400 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=monjalon.net; h= cc:content-transfer-encoding:content-type:date:from:in-reply-to :message-id:mime-version:references:subject:to:x-me-sender :x-me-sender:x-sasl-enc:x-sasl-enc; s=mesmtp; bh=ylFcwYUOKHhdsjS iicpzUbS2eVDEdHIWbdRy+T6iZRA=; b=D4RkiwxeGtLpkrBtdALr2r3mxVVSb1O GRStPBZ0lwaGOd4Zp80RbMsOylmG7Ku5VJ+n3X1qDgxewxWWAuk95rR6iO0XJqKs r2bWC8uO+ocky/z4nnGepPAlk6w6lRc6a+Nnu0C3JfwbjURt60PDghCwi1S2LRYu 89MWJsQh3f0o= DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d= messagingengine.com; h=cc:content-transfer-encoding:content-type :date:from:in-reply-to:message-id:mime-version:references :subject:to:x-me-sender:x-me-sender:x-sasl-enc:x-sasl-enc; s= fm1; bh=ylFcwYUOKHhdsjSiicpzUbS2eVDEdHIWbdRy+T6iZRA=; b=DJZpYI8F RezPV9NPY9CcyDfSVPxiSlvIsfRHN35bQYMk8MfVRmNLExSQo31IYvT4923fseTw NdzdBdjLFmN/AB+S+0Nga1VbAKbw+klxkJF4s+5En9ALumbefE2HLgru2KwAXZm+ 2JYYPQhbwRaUYduTEw75MMo0IaF8tk0eF5QWZ5GDG1J1t9j6YsfEYKNPTrhPqqby pmjMuRFMnx/h/zTm62ghV54T0hu6869YrLpGd6IhzU/qMFo6/AzAnP7fomLu9ghy lDuI8mIvv+Juna5rebGvIUWTn8jD2NcDGHSJLUQKljem/YN6Ju5LV363+anuPUg0 N53HZHw5BZieIg== X-ME-Sender: X-Sasl-enc: FoDcLy6hzQJ4MXkn8X0ZqjOxsFPeuOv5X+ipDHLbbzbV 1501841422 Received: from xps.localnet (159.16.90.92.rev.sfr.net [92.90.16.159]) by mail.messagingengine.com (Postfix) with ESMTPA id C66392436A; Fri, 4 Aug 2017 06:10:22 -0400 (EDT) From: Thomas Monjalon To: Ferruh Yigit Cc: dev@dpdk.org, John McNamara , Olivier Matz Date: Fri, 04 Aug 2017 12:10:11 +0200 Message-ID: <3910772.dyrDr9423A@xps> In-Reply-To: <9e854181-70a1-810d-8e6e-ebf6589bab00@intel.com> References: <20170720092303.97525-1-ferruh.yigit@intel.com> <1557856.DY0fuUa5Sa@xps> <9e854181-70a1-810d-8e6e-ebf6589bab00@intel.com> MIME-Version: 1.0 Content-Transfer-Encoding: 7Bit Content-Type: text/plain; charset="us-ascii" Subject: Re: [dpdk-dev] [PATCH v6] doc: document NIC features X-BeenThere: dev@dpdk.org X-Mailman-Version: 2.1.15 Precedence: list List-Id: DPDK patches and discussions List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Fri, 04 Aug 2017 10:10:25 -0000 04/08/2017 12:04, Ferruh Yigit: > On 8/4/2017 10:32 AM, Thomas Monjalon wrote: > > 04/08/2017 10:56, Ferruh Yigit: > >> On 8/3/2017 11:57 PM, Thomas Monjalon wrote: > >>> 01/08/2017 17:23, Ferruh Yigit: > >>>> +:orphan: > >>>> + > >>>> +.. _nic_overview_features: > >>> > >>> Why have you done an orphan page? > >>> I think it should be in doc/guides/nics/overview.rst > >> > >> There is a link from nics/overview.rst to this file. But this file is > >> not in the index and not making it orphan is causing a build warning. > > > > But why creating a new page? > > It could be below the table in overview.rst. > > Overview page is mostly just a table, this is more simple and clean I > believe. > > Instead, I was thinking to be able to find a way to make each feature > name a link to its description in this file. Could we have a link to a section in the same page? My main concern is that orphan page is weird in sphinx. And from a usability point of view, users prefer looking for pages from the menu at the left.