Building docs

Hi all,

While trying to work on some docs for mplot3d I ran into trouble
building them. I started with the stock ubuntu sphinx (0.5.2), but
that ran into errors. Following the documentation suggestion I tried
the repository at http://svn.python.org/projects/doctools/trunk
sphinx, but that seems to be deprecated (and also didn't work for me).
Apparently the new location is a mercurial repo at
http://bitbucket.org/birkenfeld/sphinx/ and that's a version that did
the trick for me.

My guess is people knew this already, but shall I update the docs with
this new repo? It will be easier for new people to get the docs built.

Regards,

···

--
Reinier Heeres
Bleijenburg 64
2511 VD Den Haag
The Netherlands

Tel: +31 6 10852639

Reinier Heeres wrote:

Hi all,

While trying to work on some docs for mplot3d I ran into trouble
building them. I started with the stock ubuntu sphinx (0.5.2), but
that ran into errors. Following the documentation suggestion I tried
the repository at http://svn.python.org/projects/doctools/trunk
sphinx, but that seems to be deprecated (and also didn't work for me).
Apparently the new location is a mercurial repo at
http://bitbucket.org/birkenfeld/sphinx/ and that's a version that did
the trick for me.

My guess is people knew this already, but shall I update the docs with
this new repo? It will be easier for new people to get the docs built.

Yes, please do.

Eric

By all means the current docs should be updated with anything that
makes it easier for new users. I often forget this stuff in the
intervals between when I have to set up new development stations, so
having easy step-by-step instructions with command lines to paste into
the shell is a definite plus

JDH

···

On Thu, May 28, 2009 at 3:32 PM, Reinier Heeres <reinier@...707...> wrote:

Hi all,

While trying to work on some docs for mplot3d I ran into trouble
building them. I started with the stock ubuntu sphinx (0.5.2), but
that ran into errors. Following the documentation suggestion I tried
the repository at http://svn.python.org/projects/doctools/trunk
sphinx, but that seems to be deprecated (and also didn't work for me).
Apparently the new location is a mercurial repo at
http://bitbucket.org/birkenfeld/sphinx/ and that's a version that did
the trick for me.

My guess is people knew this already, but shall I update the docs with
this new repo? It will be easier for new people to get the docs built.

Hey Reiner,

I just did an svn up and noticed the new examples for mplot3d --
thanks for adding these. May I suggest you rename them? Having file
names like contour, when mpl has a module contour, can lead to subtle
import bugs. We try and avoid these by doing fully qualified imports
inside mpl like 'import matplotlib.contour as contour' but to keep
things clear and simple I like to post fix '_demo' or something like
that on examples when the same is potentially ambiguous. Some
something like
contour3d_demo.py, scatter3d_demo.py, etc, would be preferable to me
to clearly disambiguate the modules and examples, with judicious use
of 3d to make it clear what the examples are.

Thanks,
JDH

···

On Thu, May 28, 2009 at 3:32 PM, Reinier Heeres <reinier@...707...> wrote:

Hi all,

While trying to work on some docs for mplot3d I ran into trouble
building them. I started with the stock ubuntu sphinx (0.5.2), but
that ran into errors. Following the documentation suggestion I tried
the repository at http://svn.python.org/projects/doctools/trunk
sphinx, but that seems to be deprecated (and also didn't work for me).
Apparently the new location is a mercurial repo at
http://bitbucket.org/birkenfeld/sphinx/ and that's a version that did
the trick for me.