[Django] #25696: Add sphinx extension to django.contrib

[Django]

#25696: Add sphinx extension to django.contrib
-------------------------------+--------------------------
Reporter: codingjoe | Owner: nobody
Type: New feature | Status: new
Component: Documentation | Version: 1.8
Severity: Normal | Keywords: sphinx, docs
Triage Stage: Unreviewed | Has patch: 0
Easy pickings: 0 | UI/UX: 0
-------------------------------+--------------------------
As I proposed at DUTH2015, it would be great to not only have beautiful
Django documentation, but to allow users to create documentations of their
projects in a breeze.

To achieve that, I'd like to propose a sphinx extension in
`django.contrib` that manly handles:
- Keeping the inspector from iterating of querysets/managers.
- Monkey patching or fixing `FieldDescriptors` eg. FileFields
- Fixing field pathes for intersphinx. Intersphinx doesn't work with eg.
`django.db.models.fields.CharField` but only `django.db.models.CharField`

I have some code snippets ready, but not a sphinx extension yet. It is
also in question, if the extension should do a lot of monkey patching
instead of fixing some implementation issues in django.

--
Ticket URL: <https://code.djangoproject.com/ticket/25696>
Django <https://code.djangoproject.com/>
The Web framework for perfectionists with deadlines.

[Django]

#25696: Add sphinx extension to django.contrib

-------------------------------+--------------------------------------
Reporter: codingjoe | Owner: nobody
Type: New feature | Status: closed
Component: Documentation | Version: 1.8
Severity: Normal | Resolution: wontfix

Keywords: sphinx, docs | Triage Stage: Unreviewed

Has patch: 0 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0

Easy pickings: 0 | UI/UX: 0

-------------------------------+--------------------------------------
Changes (by timgraham):

* status: new => closed
* needs_better_patch: => 0
* resolution: => wontfix
* needs_tests: => 0
* needs_docs: => 0

Comment:

I'm not yet convinced that this is something that needs to live in Django
itself at this time. I'd like to see it (at least initially) as a third-
party package which should allow you to iterate more quickly before we
consider it for inclusion in Django. Please let the DevelopersMailingList
know when you have something to share, or feel free to reach out to me
directly for feedback. Thanks!

--
Ticket URL: <https://code.djangoproject.com/ticket/25696#comment:1>

[Django]

#25696: Add sphinx extension to django.contrib

-------------------------------+--------------------------------------
Reporter: codingjoe | Owner: nobody
Type: New feature | Status: closed
Component: Documentation | Version: 1.8
Severity: Normal | Resolution: wontfix

Keywords: sphinx, docs | Triage Stage: Unreviewed

Has patch: 0 | Needs documentation: 0

Needs tests: 0 | Patch needs improvement: 0

Easy pickings: 0 | UI/UX: 0

-------------------------------+--------------------------------------

Comment (by codingjoe):

Thanks, will do.

--
Ticket URL: <https://code.djangoproject.com/ticket/25696#comment:2>