#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.
--
You received this message because you are subscribed to the Google Groups
"Django updates" group.
To unsubscribe from this group and stop receiving emails from it, send an email
to [email protected].
To post to this group, send email to [email protected].
To view this discussion on the web visit
https://groups.google.com/d/msgid/django-updates/052.c7a1a74ed6c07414308506b9dee3b124%40djangoproject.com.
For more options, visit https://groups.google.com/d/optout.
