Hi,
Jakub spotted this problem with mpl and new sphinx:
In Sphinx 1.0, ":param" field can accept up to 2 whitespace-separated
arguments. Unforunately, this new feature breaks a bit documentation of some
stuff in the mpl_toolkits.axes_grid.axes_divider module, which is using
spaces for its own purpose:$ grep -E -r 'param [^ ]* [^ ]*:' .
./lib/mpl_toolkits/axes_grid/axes_divider.py: :param nx, nx1:
Integers specifying the column-position of the
./lib/mpl_toolkits/axes_grid/axes_divider.py: :param ny, ny1: same as
nx and nx1, but for row positions.
./lib/mpl_toolkits/axes_grid/axes_divider.py: :param nx, nx1:
Integers specifying the column-position of the
./lib/mpl_toolkits/axes_grid/axes_divider.py: :param ny, ny1: same as
nx and nx1, but for row positions.
./lib/mpl_toolkits/axes_grid/axes_divider.py: :param nx, nx1:
Integers specifying the column-position of the
./lib/mpl_toolkits/axes_grid/axes_divider.py: :param ny, ny1: same as
nx and nx1, but for row positions.[0] See bottom of:
http://sphinx.pocoo.org/domains.html#info-field-lists
That generates pages like this:
locate(nx, ny, nx1=None, ny1=None, renderer=None)¶
Parameters:
* nx1 (nx,) – Integers specifying the column-position of the
cell. When nx1 is None, a single nx-th column is specified. Otherwise
location of columns spanning between nx to nx1 (but excluding nx1-th
column) is specified.
* ny1 (ny,) – same as nx and nx1, but for row positions.
With the attached patch, I removed the space between those arguments,
but at least it generates a correct list even tho it's a bit visually
unpleasant.
Cheers,
50_bts608942_spaces_in_param_args.patch (2.25 KB)
···
On Tue, Jan 4, 2011 at 20:47, Jakub Wilk <jwilk@...12...> wrote:
--
Sandro Tosi (aka morph, morpheus, matrixhasu)
My website: http://matrixhasu.altervista.org/
Me at Debian: http://wiki.debian.org/SandroTosi