#11152: Some classes missing in documentation
---------------------------------+------------------------------------------
Reporter: ben | Owner: nobody
Status: new | Milestone:
Component: Documentation | Version: 1.0
Keywords: autodoc intersphinx | Stage: Unreviewed
Has_patch: 0 |
---------------------------------+------------------------------------------
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
}}}
[http://docs.djangoproject.com/en/dev/ref/templates/api/#rendering-a-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:
1. Is this a one off or is django not making full use of sphinx?
2. 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)
3. 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?
Ben
--
Ticket URL: <http://code.djangoproject.com/ticket/11152>
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
-~----------~----~----~----~------~----~------~--~---
