[dpdk-dev] [PATCH v6] doc: document NIC features

Thomas Monjalon thomas at monjalon.net
Fri Aug 4 12:10:11 CEST 2017


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.


More information about the dev mailing list