matplotlib-devel Mailing List for matplotlib (Page 17)

On Sat, May 31, 2008 at 9:01 PM, Fernando Perez <fpe...@gm...> wrote:

> I don't know if you are so in the middle of things that you'd rather
> not get bug reports on this for a while.  If that's the case I'll wait
> until the dust settles a bit.

Well, we definitely want our docs to build so we're happy to get the
feedback -- sometimes it's a simple matter of a dev forgetting to
commit a critical file.  I am getting this error too.  It appears to
be a bug in the pyplot docstrings -- Darren, perhaps you haven't
committed all you recent changes?  But if I remove entirely the pyplot
api doc which is causing this problem, I get lots of other errors
along the lines of those shown below.  Is this a latex or sphinxext
config error?

[8 <./pyplot_formatstr.png> <./pyplot_three.png>] [9] [10]
<pyplot_two_subplots.png, id=368, 578.16pt x 433.62pt>
<use pyplot_two_subplots.png> <use pyplot_two_subplots.png> [11 <./pyplot_two_s
ubplots.png>] <pyplot_text.png, id=375, 578.16pt x 433.62pt>
<use pyplot_text.png> <use pyplot_text.png> [12 <./pyplot_text.png>] [13]
[14]
Chapter 2.
[15] [16]
! Undefined control sequence.
<recently read> \mathbb

l.954 \end{tabulary}

?
! Undefined control sequence.
<recently read> \mathcircled

l.954 \end{tabulary}


...and lots more like this....

JDH

Hey folks,

I'm super excited about this, so I decided to give it a quick test run
with current trunk SVN.  Running ./make.py in the doc/ directory
worked for a while, and then stalled at:


Sphinx v0.3, building latex
trying to load pickled env... done
building [latex]: all documents
updating environment: 0 added, 0 changed, 0 removed
processing Matplotlib.tex... index users/index users/pyplot_tutorial
users/mathtext users/navigation_toolbar users/customizing
users/artists users/event_handling faq/index faq/installing_faq
faq/troubleshooting_faq faq/howto_faq devel/index devel/coding_guide
devel/documenting_mpl devel/add_new_projection api/index
api/artist_api api/pyplot_api
resolving references...
writing... Exception occurred:
  File "/home/fperez/usr/local/lib/python2.5/site-packages/Sphinx-0.3-py2.5.egg/sphinx/latexwriter.py",
line 479, in visit_entry
    raise NotImplementedError('Column or row spanning cells are '
NotImplementedError: Column or row spanning cells are not implemented.
The full traceback has been saved in /tmp/sphinx-err-l_Oadi.log, if
you want to report the issue to the author.
Please also report this if it was a user error, so that a better error
message can be provided next time.
Send reports to sph...@go.... Thanks!
This is pdfTeXk, Version 3.141592-1.40.3 (Web2C 7.5.6)
 %&-line parsing enabled.
entering extended mode
! I can't find file `Matplotlib.tex'.
<*> Matplotlib.tex

Please type another input file name:


I don't know if you are so in the middle of things that you'd rather
not get bug reports on this for a while.  If that's the case I'll wait
until the dust settles a bit.

In any case, many thanks for pushing this doc effort forward!  The
overall usability of the combined tools, in a few months, is going to
really be massively improved thanks to all  this common focus on
sphinx-based docs.

Cheers,

f

On Saturday 31 May 2008 4:14:39 pm Darren Dale wrote:
> On Saturday 31 May 2008 12:36:11 pm John Hunter wrote:
> > On Sat, May 31, 2008 at 9:19 AM, Darren Dale <dar...@co...>
>
> wrote:
> > > I'll be working on converting docstrings to rest this weekend. Should
> > > any of this be done on the branch? Or should we just focus on the
> > > trunk?
> >
> > As far as I am concerned, the documentation effort is for the trunk.
>
> I would really prefer to concentrate on the trunk. There's enough work as
> it is.

I made some pretty good progress today. I found the source of that error that 
was causing sphinx to fail without a helpfull message, there was a ********* 
in the contour documentation. pyplot_api is about halfway converted, there 
are only 60 warnings reported by sphinx for pyplot.

I just realized, though, that I should probably be striving to conform with 
the standard that the numpy and scipy folks put together: 
http://projects.scipy.org/scipy/numpy/wiki/CodingStyleGuidelines and 
http://svn.scipy.org/svn/numpy/trunk/numpy/doc/example.py . Any comments? I 
think I have been relying too heavily on tables for the keyword arguments.

Darren