Docs misidentify modules for classes/functions
|Reported by:||Owned by:||Gabriel Hurley|
|Severity:||Keywords:||module directives index|
|Has patch:||yes||Needs documentation:||no|
|Needs tests:||no||Patch needs improvement:||no|
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
method directives so that the documented objects will be documented with correct paths.
Change History (11)
comment:8 Changed 6 years ago by
|Owner:||changed from nobody to Gabriel Hurley|
|Status:||reopened → new|