numam-dpdk/doc/guides
John McNamara 4a22e6ee3d 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>
2015-05-25 15:59:36 +02:00
..
freebsd_gsg doc: fix spellings and typos 2015-04-29 18:34:58 +02:00
linux_gsg drivers: create new directory 2015-05-22 15:51:38 +02:00
nics doc: refactor figure numbers into references 2015-05-25 15:59:36 +02:00
prog_guide doc: refactor figure numbers into references 2015-05-25 15:59:36 +02:00
rel_notes doc: fix spellings and typos 2015-04-29 18:34:58 +02:00
sample_app_ug doc: refactor figure numbers into references 2015-05-25 15:59:36 +02:00
testpmd_app_ug doc: fix spellings and typos 2015-04-29 18:34:58 +02:00
xen doc: refactor figure numbers into references 2015-05-25 15:59:36 +02:00
conf.py doc: refactor figure numbers into references 2015-05-25 15:59:36 +02:00
index.rst doc: nics guide 2015-03-31 01:33:22 +02:00