From: John McNamara <john.mcnamara@intel.com>
To: dev@dpdk.org
Subject: [dpdk-dev] [PATCH v3 0/3] doc: refactored fig and table nums into references
Date: Mon, 18 May 2015 12:34:05 +0100 [thread overview]
Message-ID: <1431948848-3842-1-git-send-email-john.mcnamara@intel.com> (raw)
In-Reply-To: <1429881109-16684-1-git-send-email-john.mcnamara@intel.com>
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
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
next prev parent reply other threads:[~2015-05-18 11:34 UTC|newest]
Thread overview: 17+ messages / expand[flat|nested] mbox.gz Atom feed top
2015-04-24 13:11 [dpdk-dev] [PATCH 0/2] " John McNamara
2015-04-24 13:11 ` [dpdk-dev] [PATCH 1/2] doc: refactored figure numbers " John McNamara
2015-04-24 13:11 ` [dpdk-dev] [PATCH 2/2] doc: refactored table " John McNamara
2015-04-29 16:12 ` [dpdk-dev] [PATCH 0/2] doc: refactored fig and table nums " Thomas Monjalon
2015-04-30 13:34 ` Mcnamara, John
2015-05-13 19:07 ` Thomas Monjalon
2015-05-14 10:41 ` Mcnamara, John
2015-05-18 10:48 ` Mcnamara, John
2015-05-18 11:15 ` [dpdk-dev] [PATCH v2 0/3] " John McNamara
2015-05-18 11:15 ` [dpdk-dev] [PATCH 1/3] doc: refactored figure numbers " John McNamara
2015-05-18 11:15 ` [dpdk-dev] [PATCH v2 3/3] doc: add sphinx numref compatibility workaround John McNamara
2015-05-18 11:34 ` John McNamara [this message]
2015-05-18 11:34 ` [dpdk-dev] [PATCH v3 1/3] doc: refactored figure numbers into references John McNamara
2015-05-18 11:34 ` [dpdk-dev] [PATCH v3 2/3] doc: refactored table " John McNamara
2015-05-18 11:34 ` [dpdk-dev] [PATCH v3 3/3] doc: add sphinx numref compatibility workaround John McNamara
2015-05-25 14:05 ` [dpdk-dev] [PATCH v3 0/3] doc: refactored fig and table nums into references Thomas Monjalon
2015-05-25 16:37 ` Mcnamara, John
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=1431948848-3842-1-git-send-email-john.mcnamara@intel.com \
--to=john.mcnamara@intel.com \
--cc=dev@dpdk.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).