matplotlib-devel Mailing List for matplotlib

Hi Fernando and all,

>
> Speaking of sphinx for books, as I've mentioned before to John, the
> last big problem is being able to cross-reference arbitrary text
> elements like you can in latex, be they chapters or sections or
> whatever, and get a number or something that's meaningful in print.
>
> I looked around, and apparently it's on the main docutils todo list:
>
> http://docutils.sourceforge.net/docs/dev/todo.html#object-numbering-and-object-references
>
> I hope we don't have to be the ones fixing that one...
>

I should also mention bibliography - using a bibtex bibliography is
also still quite impossible at the moment, without going in and
editing the .tex and running the tex (latex=>bibtex=>latex=>latex)
commands on it yourself. Does anyone of the Sphinx mavens around here
know anything about how to get Sphinx to do that for you? I am
starting to believe that Sphinx can be made to do just about anything
we would want it to for these kinds of uses.

Cheers,

Ariel

On Sat, Sep 12, 2009 at 11:12 PM, Fernando Perez <fpe...@gm...> wrote:

> Here's a diff against current trunk to play with this idea.

Updated patch that handles correctly more than one option (I think the
bug was even in the original, not sure).

Cheers,

f

On Sat, Sep 12, 2009 at 8:29 PM, Fernando Perez <fpe...@gm...> wrote:

> Before I dive into the code too far, I figured I'd ask the experts.

Too late for that, common sense has never been my forte.

Here's a diff against current trunk to play with this idea.

WARNING: Please note that this is NOT meant to be applied for mpl yet!!!

I've actually modified the plot directive and renamed it to 'figplot',
so we can experiment a little to better understand things.  The point
is that this now lets us write reST of this type:

.. figplot:: code/make_figure_brainx.py
   :width: 3.6 in

   **Example from fMRI data:** In the graph presented, the nodes represent the
   areas of the brain described in Figure 1. Nodes are labeled accordingly and
   etc...

The text block is then passed as a caption to latex.

I renamed it because there's a bit of a conflict with the current
'plot' directive, which allows a filename *or* a content block, but in
that case the content block is meant to be the source code, as
illustrated in sampledoc:

http://matplotlib.sourceforge.net/sampledoc/extensions.html#inserting-matplotlib-plots

Since I'm not sure if we can find a clean solution to:

- path to script: goes into arg list
- inlined (multiline) code: goes into content block
- inlined (possibly multiline) caption: goes into content block

I put this version so we can start experimenting.  This does what
Ariel and I need, but I hope over time we can figure out a good
long-term solution.


Speaking of sphinx for books, as I've mentioned before to John, the
last big problem is being able to cross-reference arbitrary text
elements like you can in latex, be they chapters or sections or
whatever, and get a number or something that's meaningful in print.

I looked around, and apparently it's on the main docutils todo list:

http://docutils.sourceforge.net/docs/dev/todo.html#object-numbering-and-object-references

I hope we don't have to be the ones fixing that one...

Cheers,

f

Hi folks,

if one were to say, think of writing something like a book (or a
paper) using sphinx and plots generated from python scripts, the plot
directive would be extremely useful.  But as best as I can tell, it
generates at the end of the day 'image' directives, where as for
including figures in latex-produced PDF with captions and labels one
can later refer to, the plain sphinx 'figure' directive appears to be
more appropriate.  As we can read here:

http://docutils.sourceforge.net/docs/ref/rst/directives.html#images

Their signatures are:

Image
Directive Type:	"image"
Doctree Element:	image
Directive Arguments:	One, required (image URI).
Directive Options:	Possible.
Directive Content:	None.

Figure
Directive Type:	"figure"
Doctree Elements:	figure, image, caption, legend
Directive Arguments:	One, required (image URI).
Directive Options:	Possible.
Directive Content:	Interpreted as the figure caption and an optional legend.

A key difference is that image takes no content, while figure accepts
content and uses it for the figure caption.

Would it be possible/sensible to switch the plot directive to be a
superset of 'figure' instead of 'image'?

Before I dive into the code too far, I figured I'd ask the experts.

Thanks!

f