[dpdk-dev] [PATCH v3 0/3] doc: refactored fig and table nums into references

Thomas Monjalon thomas.monjalon at 6wind.com
Mon May 25 16:05:50 CEST 2015


2015-05-18 12:34, John McNamara:
> This patchset adds automatic figure and table references to the docs. The
> figure and table numbers in the generated Html and PDF docs can now be
> automatically numbered.
> 
> It replaces all hardcoded figure/table numbers and references.
> 
> The numfig/numref feature requires Sphinx >= 1.3.1. For backward compatibility
> with older versions workaround handling is added to the sphinx conf.py file in
> patch 3/3.
> 
> The workaround replaces the :numref: reference with a "Figure" or "Table" link
> to the target (for all Sphinx doc types). It doesn't number the figures or
> tables. This produces reasonable documentation links for users with older
> versions of sphinx while allowing automatic numbering support for newer
> versions.
> 
> Tested with Sphinx 1.2.3 and 1.3.1.
> 
> John McNamara (3):
>   doc: refactored figure numbers into references
>   doc: refactored table numbers into references
>   doc: add sphinx numref compatibility workaround

Applied, thanks
It will be easier to add/remove figures and tables now :)

John, I did some light modifications in comments that I think you'd agree.

This is a really nice feature for the doc and I think this fallback should
be documented somewhere in the sphinx project.


More information about the dev mailing list