From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mail-wg0-f50.google.com (mail-wg0-f50.google.com [74.125.82.50]) by dpdk.org (Postfix) with ESMTP id DE728C85C for ; Wed, 29 Apr 2015 18:50:21 +0200 (CEST) Received: by wgyo15 with SMTP id o15so34999991wgy.2 for ; Wed, 29 Apr 2015 09:50:21 -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=3FXSVsvDx28ahLxRdBpBKlhEKolugtB50u1I0+mM0Go=; b=Qxjay4hWLI0tcNiHnucJ3NIqh/Mia4NqHomtqo2vmsInAS003vDLu7oB5JzfJsTXZy jrvWtUrO1Zh/Rcieey5oU0qhkOND4oEa7kDAZUaeAOvtaDJVpfHIW0m/6HGFDXxh6mFJ nYhQKXEji1+jy7TWlNaJ3KPdwjouitvMhiUF6+V1ZP0L0uNyDhESgG8T9HF80sziOgIk 87RZ6vLAYGJ4a56tovpLmYWB7ZUUzABnfPDU28R1P7gz//j4A0GlbdKlmhOWDQFFaI4S BuLng90mLkgr2SXcO8jYDOY2WVnDSR2/3H+JFUspEfNBzKpmL1MNNk6vE/RoSZCVGDJ8 wGdQ== X-Gm-Message-State: ALoCoQlYQ9hfgvgxvYSSW8H2bP0a3eMle362wCJ35Dd5PWmhNFgHH6z9LcaTCvPrIGvDZBrGWP2G X-Received: by 10.194.173.226 with SMTP id bn2mr44499865wjc.148.1430325807840; Wed, 29 Apr 2015 09:43:27 -0700 (PDT) Received: from xps13.localnet (60.26.90.92.rev.sfr.net. [92.90.26.60]) by mx.google.com with ESMTPSA id m1sm21950856wiw.7.2015.04.29.09.43.26 (version=TLSv1 cipher=ECDHE-RSA-RC4-SHA bits=128/128); Wed, 29 Apr 2015 09:43:27 -0700 (PDT) From: Thomas Monjalon To: John McNamara Date: Wed, 29 Apr 2015 18:12:44 +0200 Message-ID: <4018323.hxXVqqSkHq@xps13> Organization: 6WIND User-Agent: KMail/4.14.7 (Linux/3.19.3-3-ARCH; KDE/4.14.7; x86_64; ; ) In-Reply-To: <1429881109-16684-1-git-send-email-john.mcnamara@intel.com> References: <1429881109-16684-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 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: Wed, 29 Apr 2015 16:50:22 -0000 Hi John, 2015-04-24 14:11, John McNamara: > 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. This is really a great work but I think it's not reasonnable to require sphinx 1.3. As almost nobody is using this version, it would be equivalent to prevent users and developers to generate the doc by themselves. It produces this error: ERROR: Unknown interpreted text role "numref". Do you think it's possible to implement a fallback in our conf.py in order to ignore this new role if not supported?