Opened 15 years ago

Closed 14 years ago

Last modified 13 years ago

#12975 closed (fixed)

Docs for contrib.admindocs?

Reported by: Jared Forsyth Owned by: nobody
Component: Documentation Version: 1.1
Severity: Keywords: docs, admindocs, api
Cc: Triage Stage: Accepted
Has patch: yes Needs documentation: no
Needs tests: no Patch needs improvement: yes
Easy pickings: no UI/UX: no

Description

I for one would like some API documentation for the contrib.admindocs module -- it seems to be missing on http://docs.djangoproject.com/en/1.1/#other-batteries-included

Attachments (3)

0001-Changed-references-to-reST-and-reStructuredText-for-.patch (5.3 KB ) - added by Nathaniel Whiteinge 14 years ago.
Consistency patch for references to reStructuredText.
0002-Basic-admindocs-documentation.patch (12.3 KB ) - added by Nathaniel Whiteinge 14 years ago.
Initial stab at documentation for the admindocs app.
0001-Basic-admindocs-documentation.patch (13.2 KB ) - added by Nathaniel Whiteinge 14 years ago.
Updated patch to apply cleanly.

Download all attachments as: .zip

Change History (11)

comment:1 by Russell Keith-Magee, 15 years ago

Triage Stage: UnreviewedAccepted

by Nathaniel Whiteinge, 14 years ago

Consistency patch for references to reStructuredText.

by Nathaniel Whiteinge, 14 years ago

Initial stab at documentation for the admindocs app.

comment:2 by Nathaniel Whiteinge, 14 years ago

Here are two documentation patches. (Or GitHub for those inclined.)

The first isn't all that related to this ticket, but since I was writing about reStructuredText the inconsistent references in the existing docs tickled my OCD.

The second is the actual admindocs documentation patch. I moved the existing reference to admindocs in templates.txt to it's own document and added some stuff. I also reworded a few things in that existing section that were inaccurate.

comment:3 by Derek Willis, 14 years ago

Has patch: set

comment:4 by Gabriel Hurley, 14 years ago

milestone: 1.3
Patch needs improvement: set

So, first off, great job writing the new docs for admindocs whiteinge! Those are really excellent and I learned plenty by reading them, not being a heavy user of admindocs myself.

All in all this patch is just about ready. The main thing that needs to happen, though, is that both patches need to be updated to apply cleanly to trunk (currently neither of them applies).

If someone will do that, I'll take care of the last couple tweaks and get it committed! I'd love to see this go in for 1.3.

by Nathaniel Whiteinge, 14 years ago

Updated patch to apply cleanly.

comment:5 by Nathaniel Whiteinge, 14 years ago

  • Updated patch to apply cleanly (and made some minor improvements). (Newest attached patch or GitHub.)
  • Dropped the reST-consistency patch which made it into #14383.

Thanks, gabrielhurley, for taking this under your wing!

comment:6 by Gabriel Hurley, 14 years ago

Resolution: fixed
Status: newclosed

(In [14484]) Fixed #12975 -- Moved the docs for contrib.admindocs out of the template docs and into their own reference section, and significantly improved the documentation of what admindocs can do. Thanks to jabapyth for the report, and whiteinge for the patch.

comment:7 by Gabriel Hurley, 14 years ago

(In [14485]) [1.2.X] Fixed #12975 -- Moved the docs for contrib.admindocs out of the template docs and into their own reference section, and significantly improved the documentation of what admindocs can do. Thanks to jabapyth for the report, and whiteinge for the patch.

Backport of [14484] from trunk.

comment:8 by Jacob, 13 years ago

milestone: 1.3

Milestone 1.3 deleted

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