[IPython-dev] AttributeError when running sphinx docs

Fernando Perez fperez.net@gmail....
Fri Aug 10 22:28:36 CDT 2012


On Fri, Aug 10, 2012 at 8:12 PM, Brian Granger <ellisonbg@gmail.com> wrote:

> Yes, it completely fails.  I am attaching the log of the TB that
> finally kills it.

Argh.. No clue.  I compared my versions and I have almost everything
the same as you, except sphinx is 1.1.3 for me, but I doubt that tiny
version delta is the issue here.

One option would be to get rid of our auto-generated API docs.  I'm
reluctant to do this because that's the kind of thing that we never
know who may regularly use them and we've had them for years.  But I
personally never use them, and they are the source of most of our
build time as well as most of the errors and warnings.  A bit brutal
of a solution, but it would go a long way to making this more
manageable.  Thoughts?

> Yep, silent errors like that are horrible.  Can we set a flag to cause
> warnings to halt the build?

Yup, call the build with -W:

http://sphinx.pocoo.org/latest/invocation.html#cmdoption-sphinx-build-W

The problem is that right now that's so depressing to do that we have
all just stuck our collective heads in the sand :)

> We currently have this category, and it is logically sound.  But these
> days the notebook almost belongs at the top-level.  But it does share
> a lot with the other frontends.  Maybe organize this "interactive"
> section according to components: qtconsole, terminal, notebook,
> kernel.  But the kernel is more of a dev level thing.

Agreed.

> I think we are ready to get rid of the plugin stuff.  I will check on
> that are submit a PR.

Great!

> I almost think that the dev guide should be done as a github wiki -
> basically use github for everything dev related.  I think that will
> encourage more people to keep those docs updated.

I'd be up for that.  And we've had the conversation about getting rid
of our wiki in favor of a github one, we might as well make that
decision with this in mind... Though probably in a separate thread to
keep the conversation manageable.

> Yes, but for now I would be happy being able to build the docs, errors
> and all ;-(

I know, I wish I knew what was going on for you.  I'm assuming you did
a make clean first, right?  I've had in the past (years ago) to debug
one of those, and all I remember is that it was a pain and put me in a
bad mood...

Cheers,

f


More information about the IPython-dev mailing list