[dpdk-dev] [PATCH v9 1/2] doc: add generic compilation doc for all sample apps

Mcnamara, John john.mcnamara at intel.com
Wed Oct 25 16:32:39 CEST 2017



> -----Original Message-----
> From: Thomas Monjalon [mailto:thomas at monjalon.net]
> Sent: Wednesday, October 25, 2017 11:27 AM
> To: Kovacevic, Marko <marko.kovacevic at intel.com>
> Cc: dev at dpdk.org; Mcnamara, John <john.mcnamara at intel.com>; Herakliusz
> Lipiec <herakliusz.lipiec at intel.com>
> Subject: Re: [dpdk-dev] [PATCH v9 1/2] doc: add generic compilation doc
> for all sample apps
> 
> 19/10/2017 14:11, Marko Kovacevic:
> > +.. _sample_app_compilation:
> > +
> > +Compiling the Sample Applications
> > +=================================
> 
> I think we should stop adding useless anchors.
> I may be wrong but I don't see the benefit of
> 	:ref:`sample_app_compilation`
> compared to
> 	:doc:`compiling`


There is an advantage when the referred to section isn't the first section in the docs:

"Using ref is advised over standard reStructuredText links to sections (like `Section title`_)
because it works across files, when section headings are changed, and for all builders 
that support cross-references."
http://www.sphinx-doc.org/en/stable/markup/inline.html#cross-referencing-anything

However, that isn't the case here. So it would be better to use :doc:.

John


More information about the dev mailing list