doc: refactor figure numbers into references
authorJohn McNamara <john.mcnamara@intel.com>
Mon, 18 May 2015 11:34:06 +0000 (12:34 +0100)
committerThomas Monjalon <thomas.monjalon@6wind.com>
Mon, 25 May 2015 13:59:36 +0000 (15:59 +0200)
commit4a22e6ee3d2f8be8afd5b374a8916e232ab7fe97
treea0747fbf3e75e6d7d90abdec44e2f2fc6abe177b
parent536884d6963164ebba88f3633d2e22e5bbcc069c
doc: refactor figure numbers into references

This change adds automatic figure references to the docs. The
figure numbers in the generated Html and PDF docs are now
automatically numbered based on section.

Requires Sphinx >= 1.3.1.

The patch makes the following changes.

* Changes image:: tag to figure:: and moves image caption
  to the figure.

* Adds captions to figures that didn't previously have any.

* Un-templates the |image-name| substitution definitions
  into explicit figure:: tags. They weren't used more
  than once anyway and Sphinx doesn't support them
  for figure.

* Adds a target to each image that didn't previously
  have one so that they can be cross-referenced.

* Renamed existing image target to match the image
  name for consistency.

* Replaces the Figures lists with automatic :numref:
  :ref: entries to generate automatic numbering
  and captions.

* Replaces "Figure" references with automatic :numref:
  references.

Signed-off-by: John McNamara <john.mcnamara@intel.com>
38 files changed:
doc/guides/conf.py
doc/guides/nics/index.rst
doc/guides/nics/intel_vf.rst
doc/guides/nics/virtio.rst
doc/guides/nics/vmxnet3.rst
doc/guides/prog_guide/env_abstraction_layer.rst
doc/guides/prog_guide/index.rst
doc/guides/prog_guide/ivshmem_lib.rst
doc/guides/prog_guide/kernel_nic_interface.rst
doc/guides/prog_guide/link_bonding_poll_mode_drv_lib.rst
doc/guides/prog_guide/lpm6_lib.rst
doc/guides/prog_guide/lpm_lib.rst
doc/guides/prog_guide/malloc_lib.rst
doc/guides/prog_guide/mbuf_lib.rst
doc/guides/prog_guide/mempool_lib.rst
doc/guides/prog_guide/multi_proc_support.rst
doc/guides/prog_guide/overview.rst
doc/guides/prog_guide/packet_distrib_lib.rst
doc/guides/prog_guide/packet_framework.rst
doc/guides/prog_guide/qos_framework.rst
doc/guides/prog_guide/ring_lib.rst
doc/guides/sample_app_ug/dist_app.rst
doc/guides/sample_app_ug/exception_path.rst
doc/guides/sample_app_ug/index.rst
doc/guides/sample_app_ug/intel_quickassist.rst
doc/guides/sample_app_ug/kernel_nic_interface.rst
doc/guides/sample_app_ug/l2_forward_job_stats.rst
doc/guides/sample_app_ug/l2_forward_real_virtual.rst
doc/guides/sample_app_ug/l3_forward_access_ctrl.rst
doc/guides/sample_app_ug/load_balancer.rst
doc/guides/sample_app_ug/multi_process.rst
doc/guides/sample_app_ug/qos_scheduler.rst
doc/guides/sample_app_ug/quota_watermark.rst
doc/guides/sample_app_ug/test_pipeline.rst
doc/guides/sample_app_ug/vhost.rst
doc/guides/sample_app_ug/vm_power_management.rst
doc/guides/sample_app_ug/vmdq_dcb_forwarding.rst
doc/guides/xen/pkt_switch.rst