DPDK patches and discussions
 help / color / mirror / Atom feed
From: Thomas Monjalon <thomas.monjalon@6wind.com>
To: John McNamara <john.mcnamara@intel.com>
Cc: dev@dpdk.org
Subject: Re: [dpdk-dev] [PATCH 0/2] doc: refactored fig and table nums into references
Date: Wed, 29 Apr 2015 18:12:44 +0200	[thread overview]
Message-ID: <4018323.hxXVqqSkHq@xps13> (raw)
In-Reply-To: <1429881109-16684-1-git-send-email-john.mcnamara@intel.com>

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?

  parent reply	other threads:[~2015-04-29 16:50 UTC|newest]

Thread overview: 17+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2015-04-24 13:11 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 ` Thomas Monjalon [this message]
2015-04-30 13:34   ` [dpdk-dev] [PATCH 0/2] doc: refactored fig and table nums " 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 ` [dpdk-dev] [PATCH v3 0/3] doc: refactored fig and table nums into references John McNamara
2015-05-18 11:34   ` [dpdk-dev] [PATCH v3 1/3] doc: refactored figure numbers " 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=4018323.hxXVqqSkHq@xps13 \
    --to=thomas.monjalon@6wind.com \
    --cc=dev@dpdk.org \
    --cc=john.mcnamara@intel.com \
    /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).