[dpdk-dev] [PATCH v2 0/3] split programmers guide a bit

Mcnamara, John john.mcnamara at intel.com
Thu Apr 2 09:59:19 CEST 2015


> -----Original Message-----
> From: Iremonger, Bernard
> Sent: Wednesday, April 1, 2015 6:20 PM
> To: Mcnamara, John; Thomas Monjalon
> Cc: Butler, Siobhan A; dev at dpdk.org
> Subject: RE: [dpdk-dev] [PATCH v2 0/3] split programmers guide a bit


> > The main positive is that it would give us automatic* figure/table
> > numbering in Html and PDF and the captioning looks quite good. (*This
> requires Sphinx 1.3).
> >
> > John
> >
> Hi John,
> 
> I am not sure why the captions have to be under the images.
> At present the captions are just a bold line of text before the image in
> the rst files for example, **Figure 17. Components of a DPDK KNI
> Application**

Hi Bernard,

The issue with the current solution is that the caption isn't tied to the image in any way and the pdf formatter frequently puts it on a separate page. Unfortunately, the solution to that issue, to use figure:: instead of image::, doesn't support captions above the image. If it did I would be happy to leave the placement as it is.

> This will probably affect the cross reference links as well or does the
> automatic numbering work with the links as well.

The automatic numbering can be added to the cross references as well. I'll submit an RFC patch and you can try it out and see if it is worth changing.

John



More information about the dev mailing list