Some classes missing in documentation (Template docs)
|Reported by:||ben||Owned by:||nobody|
|Has patch:||yes||Needs documentation:||no|
|Needs tests:||no||Patch needs improvement:||no|
I want to use intersphinx to connect up my documentation with django's. #10315 has made the .inv file available (and I've added a little bit of documentation there on how to make it work) but I still can't get to django.template.Context. In the docs there's a reference to:
Rendering a context¶ Once you have a compiled Template object, you can render a context -- or multiple contexts -- with it. The Context class lives at django.template.Context
However this class isn't hyperlinked (and as such a central class in django it'd be nice if its API was documented).
So a couple of questions here:
- Is this a one off or is django not making full use of sphinx?
- Is there a convention for structuring the documentation WRT autodoc stuff and narrative docs (I was lurking around when the initial move to sphinx was made but I guess I'm a little out of touch)
- Actually I just grepped (actually grinned :-D) and I can't find any references to autodoc'd stuff. Is there a reason why not?
I'm happy to add this to the docs and provide a patch, but figured I'd also raise this here to check whether maybe there's a wider issue that needs looking at?
Change History (5)
comment:1 Changed 5 years ago by russellm
- Needs documentation unset
- Needs tests unset
- Patch needs improvement unset
- Triage Stage changed from Unreviewed to Accepted
comment:2 Changed 3 years ago by adamv
- Has patch set
- Summary changed from Some classes missing in documentation to Some classes missing in documentation (Template docs)
- Version changed from 1.0 to SVN