Opened 7 years ago

Closed 7 years ago

Last modified 7 years ago

#25696 closed New feature (wontfix)

Add sphinx extension to django.contrib

Reported by: Johannes Maron Owned by: nobody
Component: Documentation Version: 1.8
Severity: Normal Keywords: sphinx, docs
Cc: Triage Stage: Unreviewed
Has patch: no Needs documentation: no
Needs tests: no Patch needs improvement: no
Easy pickings: no UI/UX: no

Description

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.

Change History (2)

comment:1 Changed 7 years ago by Tim Graham

Resolution: wontfix
Status: newclosed

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!

comment:2 Changed 7 years ago by Johannes Maron

Thanks, will do.

Note: See TracTickets for help on using tickets.
Back to Top