From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mga09.intel.com (mga09.intel.com [134.134.136.24]) by dpdk.org (Postfix) with ESMTP id 1D5A03239 for ; Fri, 24 Apr 2015 15:11:52 +0200 (CEST) Received: from fmsmga001.fm.intel.com ([10.253.24.23]) by orsmga102.jf.intel.com with ESMTP; 24 Apr 2015 06:11:52 -0700 X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.11,640,1422950400"; d="scan'208";a="700343482" Received: from irvmail001.ir.intel.com ([163.33.26.43]) by fmsmga001.fm.intel.com with ESMTP; 24 Apr 2015 06:11:51 -0700 Received: from sivswdev02.ir.intel.com (sivswdev02.ir.intel.com [10.237.217.46]) by irvmail001.ir.intel.com (8.14.3/8.13.6/MailSET/Hub) with ESMTP id t3ODBotN006091; Fri, 24 Apr 2015 14:11:50 +0100 Received: from sivswdev02.ir.intel.com (localhost [127.0.0.1]) by sivswdev02.ir.intel.com with ESMTP id t3ODBoYr016782; Fri, 24 Apr 2015 14:11:50 +0100 Received: (from jmcnam2x@localhost) by sivswdev02.ir.intel.com with id t3ODBoIW016778; Fri, 24 Apr 2015 14:11:50 +0100 From: John McNamara To: dev@dpdk.org Date: Fri, 24 Apr 2015 14:11:47 +0100 Message-Id: <1429881109-16684-1-git-send-email-john.mcnamara@intel.com> X-Mailer: git-send-email 1.7.4.1 Subject: [dpdk-dev] [PATCH 0/2] doc: refactored fig and table nums into references X-BeenThere: dev@dpdk.org X-Mailman-Version: 2.1.15 Precedence: list List-Id: patches and discussions about DPDK List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Fri, 24 Apr 2015 13:11:53 -0000 This patch 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 based on section. Requires Sphinx >= 1.3. Advantages: * Figues/tables are numbered automatically and adding/removing items no longer requires manual fixing. Disadvantages: * Requires Sphinx >= 1.3. * Table captions are above tables while figure captions are below. This is a current Sphinx/DocUtils limitation. * Both the :numref: and :ref: directives are required to link to a figure or table number and caption. John McNamara (2): doc: refactored figure numbers into references doc: refactored table numbers into references doc/guides/conf.py | 2 + 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 | 1245 ++++++++-------- doc/guides/prog_guide/qos_framework.rst | 1511 ++++++++++---------- 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 | 311 ++-- 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, 2029 insertions(+), 2125 deletions(-) -- 1.8.1.4