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

[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 by the build system.

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

 doc/guides/conf.py                                 |   82 ++
 doc/guides/nics/index.rst                          |   18 +-
 doc/guides/nics/intel_vf.rst                       |   37 +-
 doc/guides/nics/virtio.rst                         |   18 +-
 doc/guides/nics/vmxnet3.rst                        |   18 +-
 doc/guides/prog_guide/env_abstraction_layer.rst    |    8 +-
 doc/guides/prog_guide/index.rst                    |  162 +-
 doc/guides/prog_guide/ivshmem_lib.rst              |    8 +-
 doc/guides/prog_guide/kernel_nic_interface.rst     |   40 +-
 .../prog_guide/link_bonding_poll_mode_drv_lib.rst  |   43 +-
 doc/guides/prog_guide/lpm6_lib.rst                 |    8 +-
 doc/guides/prog_guide/lpm_lib.rst                  |    8 +-
 doc/guides/prog_guide/malloc_lib.rst               |    9 +-
 doc/guides/prog_guide/mbuf_lib.rst                 |   20 +-
 doc/guides/prog_guide/mempool_lib.rst              |   32 +-
 doc/guides/prog_guide/multi_proc_support.rst       |    9 +-
 doc/guides/prog_guide/overview.rst                 |    9 +-
 doc/guides/prog_guide/packet_distrib_lib.rst       |   15 +-
 doc/guides/prog_guide/packet_framework.rst         | 1275 ++++++++--------
 doc/guides/prog_guide/qos_framework.rst            | 1543 ++++++++++----------
 doc/guides/prog_guide/ring_lib.rst                 |  159 +-
 doc/guides/sample_app_ug/dist_app.rst              |   20 +-
 doc/guides/sample_app_ug/exception_path.rst        |    8 +-
 doc/guides/sample_app_ug/index.rst                 |   64 +-
 doc/guides/sample_app_ug/intel_quickassist.rst     |   11 +-
 doc/guides/sample_app_ug/kernel_nic_interface.rst  |    9 +-
 doc/guides/sample_app_ug/l2_forward_job_stats.rst  |   23 +-
 .../sample_app_ug/l2_forward_real_virtual.rst      |   22 +-
 .../sample_app_ug/l3_forward_access_ctrl.rst       |   21 +-
 doc/guides/sample_app_ug/load_balancer.rst         |    9 +-
 doc/guides/sample_app_ug/multi_process.rst         |   36 +-
 doc/guides/sample_app_ug/qos_metering.rst          |   46 +-
 doc/guides/sample_app_ug/qos_scheduler.rst         |   55 +-
 doc/guides/sample_app_ug/quota_watermark.rst       |   36 +-
 doc/guides/sample_app_ug/test_pipeline.rst         |  313 ++--
 doc/guides/sample_app_ug/vhost.rst                 |   45 +-
 doc/guides/sample_app_ug/vm_power_management.rst   |   18 +-
 doc/guides/sample_app_ug/vmdq_dcb_forwarding.rst   |   11 +-
 doc/guides/xen/pkt_switch.rst                      |   30 +-
 39 files changed, 2141 insertions(+), 2157 deletions(-)

--
1.8.1.4