Misc. problems in our Sphinx based docs

Bug #413776 reported by Brian Granger
8
This bug affects 1 person
Affects Status Importance Assigned to Milestone
IPython
Invalid
Low
Fernando Perez

Bug Description

I am observing multple problems with the Sphinx based documentation. I am using the 0.11 trunk and Sphinx 0.6.2. We need to go through our docs and probably do the following:

* Update all of our extensions to the latest version from matplotlib, etc.
* Fix all the errors we are having with our api docs.

Here are some of the actual errors:

1.

WARNING: extension 'ipython_console_highlighting' has no setup() function; is it really a Sphinx extension module?

2.

/Users/bgranger/Documents/Computation/IPython/Code/inputhook/docs/sphinxext/docscrape.py:117: UserWarning: Unknown section Options
  warn("Unknown section %s" % key)

3. When reading sources, Sphinx gives *MANY* (WARNING/2) errors about problems with our module docstrings.

4. Then we get lots of these:

(WARNING/2) toctree references unknown document u'api/generated/generated/IPython.config.api'

5.

checking consistency... /Users/bgranger/Documents/Computation/IPython/Code/inputhook/docs/source/api/generated/gen.txt:: WARNING: document isn't included in any toctree
done

Changed in ipython:
assignee: nobody → Fernando Perez (fdo.perez)
status: New → Confirmed
importance: Undecided → Low
Revision history for this message
Barry Warsaw (barry) wrote :

Note. Problem #1 is blocking several package builds in Ubuntu 11.04, natty: https://bugs.launchpad.net/ubuntu/+source/nipy/+bug/685180

Revision history for this message
Fernando Perez (fdo.perez) wrote :

thanks for the info. Please note that we've moved our bug tracking and code hosting to github,so I'm closing this report here, so we can continue any further discussion/fixes on the active tracker at:

https://github.com/ipython/ipython/issues/#issue/23

(i.e., my closing as 'invalid' simply means the bug tracker is invalid, we do care about the bug itself :)

Changed in ipython:
status: Confirmed → Invalid
To post a comment you must log in.
This report contains Public information  
Everyone can see this information.

Other bug subscribers

Remote bug watches

Bug watches keep track of this bug in other bug trackers.