#15233: Docs misidentify modules for classes/functions ---------------------------------------------------+------------------------ Reporter: Aryeh Leib Taurog <vim@…> | Owner: nobody Status: new | Milestone: Component: Documentation | Version: SVN Keywords: module directives index | Triage Stage: Unreviewed Has patch: 1 | ---------------------------------------------------+------------------------ Looking at the documentation index, I see: "reverse() (in module django.conf.urls.defaults)," but it isn't there, it's in `django.core.urlresolvers`. The problem is misplacement/omission/errors in the sphinx directives which identify the module/class of the objects begin documented.
I wrote a simple script to check the `genindex.html` file written by the html builder. It tries to import all the classes and module-level functions it finds and prints a list of the imports that fail. It's not foolproof, because some of the documented objects aren't really importable. I'm attaching a patch for the docs; I went through many of the errors reported by said script and tried to tweak the `module`, `currentmodule`, `function`, and `method` directives so that the documented objects will be documented with correct paths. -- Ticket URL: <http://code.djangoproject.com/ticket/15233> Django <http://code.djangoproject.com/> The Web framework for perfectionists with deadlines. -- You received this message because you are subscribed to the Google Groups "Django updates" group. To post to this group, send email to [email protected]. To unsubscribe from this group, send email to [email protected]. For more options, visit this group at http://groups.google.com/group/django-updates?hl=en.
