All of lore.kernel.org
 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: [PATCH v3 0/3] doc: refactored fig and table nums into references
Date: Mon, 25 May 2015 16:05:50 +0200	[thread overview]
Message-ID: <1460860.62iDQ3vzE7@xps13> (raw)
In-Reply-To: <1431948848-3842-1-git-send-email-john.mcnamara@intel.com>

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.

  parent reply	other threads:[~2015-05-25 14:06 UTC|newest]

Thread overview: 17+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2015-04-24 13:11 [PATCH 0/2] doc: refactored fig and table nums into references John McNamara
     [not found] ` <1429881109-16684-1-git-send-email-john.mcnamara-ral2JQCrhuEAvxtiuMwx3w@public.gmane.org>
2015-04-24 13:11   ` [PATCH 1/2] doc: refactored figure numbers " John McNamara
2015-04-24 13:11   ` [PATCH 2/2] doc: refactored table " John McNamara
2015-04-29 16:12   ` [PATCH 0/2] doc: refactored fig and table nums " Thomas Monjalon
2015-04-30 13:34     ` 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 ` [PATCH v2 0/3] " John McNamara
2015-05-18 11:15   ` [PATCH 1/3] doc: refactored figure numbers " John McNamara
2015-05-18 11:15   ` [PATCH v2 3/3] doc: add sphinx numref compatibility workaround John McNamara
2015-05-18 11:34 ` [PATCH v3 0/3] doc: refactored fig and table nums into references John McNamara
2015-05-18 11:34   ` [PATCH v3 1/3] doc: refactored figure numbers " John McNamara
2015-05-18 11:34   ` [PATCH v3 2/3] doc: refactored table " John McNamara
2015-05-18 11:34   ` [PATCH v3 3/3] doc: add sphinx numref compatibility workaround John McNamara
2015-05-25 14:05   ` Thomas Monjalon [this message]
2015-05-25 16:37     ` [PATCH v3 0/3] doc: refactored fig and table nums into references 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=1460860.62iDQ3vzE7@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 an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.