From mboxrd@z Thu Jan  1 00:00:00 1970
From: Thomas Monjalon <thomas.monjalon@6wind.com>
Subject: Re: [PATCH v3 0/3] doc: refactored fig and table nums
	into references
Date: Mon, 25 May 2015 16:05:50 +0200
Message-ID: <1460860.62iDQ3vzE7@xps13>
References: <1429881109-16684-1-git-send-email-john.mcnamara@intel.com>
 <1431948848-3842-1-git-send-email-john.mcnamara@intel.com>
Mime-Version: 1.0
Content-Type: text/plain; charset="us-ascii"
Content-Transfer-Encoding: 7Bit
Cc: dev@dpdk.org
To: John McNamara <john.mcnamara@intel.com>
Return-path: <dev-bounces@dpdk.org>
Received: from mail-wg0-f44.google.com (mail-wg0-f44.google.com [74.125.82.44])
 by dpdk.org (Postfix) with ESMTP id F11D55949
 for <dev@dpdk.org>; Mon, 25 May 2015 16:06:38 +0200 (CEST)
Received: by wgez8 with SMTP id z8so73976581wge.0
 for <dev@dpdk.org>; Mon, 25 May 2015 07:06:38 -0700 (PDT)
In-Reply-To: <1431948848-3842-1-git-send-email-john.mcnamara@intel.com>
List-Id: patches and discussions about DPDK <dev.dpdk.org>
List-Unsubscribe: <http://dpdk.org/ml/options/dev>,
 <mailto:dev-request@dpdk.org?subject=unsubscribe>
List-Archive: <http://dpdk.org/ml/archives/dev/>
List-Post: <mailto:dev@dpdk.org>
List-Help: <mailto:dev-request@dpdk.org?subject=help>
List-Subscribe: <http://dpdk.org/ml/listinfo/dev>,
 <mailto:dev-request@dpdk.org?subject=subscribe>
Errors-To: dev-bounces@dpdk.org
Sender: "dev" <dev-bounces@dpdk.org>

2015-05-18 12:34, 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.
> 
> 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

Applied, thanks
It will be easier to add/remove figures and tables now :)

John, I did some light modifications in comments that I think you'd agree.

This is a really nice feature for the doc and I think this fallback should
be documented somewhere in the sphinx project.