From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: 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 ; Mon, 25 May 2015 16:06:38 +0200 (CEST) Received: by wgez8 with SMTP id z8so73976581wge.0 for ; Mon, 25 May 2015 07:06:38 -0700 (PDT) X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20130820; h=x-gm-message-state:from:to:cc:subject:date:message-id:organization :user-agent:in-reply-to:references:mime-version :content-transfer-encoding:content-type; bh=uER5Rfllq9wsVqf/tCrWqF/ZmQS1G79vfhFTXuTqLyQ=; b=XcJ7auDtxJkgbBKVFQz3UAkmYBk7TboP0vQ1aJeXkY6mTydDFcZPTvyGtwSZWX2KPj f6Qi5mCfXtS4j7zFlogBsI70l23a0MD9YcUxkJJdzOLFt9kh3nkLc7hJQpert59v6MC2 c4vck6Z7I8tpcMil+0eeKqvRnUJ3YXuk8VlSm4LJSma4ysz25kBNoaFCafs6ZboxBBhD FkYW8objj+pXDJQAD1gI1HKpdPL86GMLzv/hhjGIBlu+WOO/IBqopROo38KQN2pHkj7F OV5yLGmMmEiX2p6BvK49coUTpbVNFJhc4FLQChP9vbOVmtEr2J0sd8KxQtyJXS+soZmI dagA== X-Gm-Message-State: ALoCoQn+wrURiOd8ijx0vXGFCZcmmgD03g+QKkGZQ2JZln/yJcgEDsynIKCqZoSCBnYrYfFu24bA X-Received: by 10.194.81.169 with SMTP id b9mr20889050wjy.126.1432562798741; Mon, 25 May 2015 07:06:38 -0700 (PDT) Received: from xps13.localnet (136-92-190-109.dsl.ovh.fr. [109.190.92.136]) by mx.google.com with ESMTPSA id pr7sm8894694wjc.15.2015.05.25.07.06.37 (version=TLSv1.2 cipher=ECDHE-RSA-AES128-GCM-SHA256 bits=128/128); Mon, 25 May 2015 07:06:37 -0700 (PDT) From: Thomas Monjalon To: John McNamara Date: Mon, 25 May 2015 16:05:50 +0200 Message-ID: <1460860.62iDQ3vzE7@xps13> Organization: 6WIND User-Agent: KMail/4.14.7 (Linux/4.0.1-1-ARCH; KDE/4.14.7; x86_64; ; ) In-Reply-To: <1431948848-3842-1-git-send-email-john.mcnamara@intel.com> 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-Transfer-Encoding: 7Bit Content-Type: text/plain; charset="us-ascii" Cc: dev@dpdk.org Subject: Re: [dpdk-dev] [PATCH v3 0/3] 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: Mon, 25 May 2015 14:06:39 -0000 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.