Documentation lacking import paths

[drozzy@…]

There is no way to know, from where to import classes when reading the documentation.

For example, on the generic views doc page:
​https://docs.djangoproject.com/en/dev/ref/class-based-views/
where does one import TemplateResponseMixin from?

I mean it should enable me to write something like this:
from django.[missing] import TemplateResponseMixin

But currently there is no way in the docs, to find the [missing] parameter! One has to either browse the source code, or search google in hopes that there are some examples online!

This has always been a problem throughout the Django docs. Is there a way to consistently document this?

[drozzy@…]

Took me a while to "guess" that FormMixin resides in:
django.views.generic.edit.FormMixin

[Aymeric Augustin]

where does one import TemplateResponseMixin from?

The reference page (your link) begins with a link to the topic page, where you can see that class-based generic views live in django.views.generic.

---

This has always been a problem throughout the Django docs.

I agree that import paths must be included in the docs. But I don't find it realistic to keep a ticket that basically says "read all the docs and add missing import paths" — especially when that ticket doesn't come with a patch, so I'm reluctant to accept this.

---

Is there a way to consistently document this?

The usual approach is to include import statement in code snippets.

[Preston Holmes]

I'll second the idea that a blanket ticket isn't useful. I agree the sample code should be more complete with imports often these imports are only listed in the first of several related snippets - but that is better than nothing.

By all means open individual tickets for specific examples.