Opened 10 years ago

Closed 10 years ago

Last modified 10 years ago

#23903 closed Cleanup/optimization (fixed)

Update docs/man/django-admin.1

Reported by: Tim Graham Owned by: Tim Graham <timograham@…>
Component: Documentation Version: dev
Severity: Normal Keywords:
Cc: Triage Stage: Accepted
Has patch: yes Needs documentation: no
Needs tests: no Patch needs improvement: no
Easy pickings: no UI/UX: no

Description

It contains obsolete management commands and is missing many new ones. I am in favor of removing it as I think django-admin --help should be the canonical location for this information and don't think duplicating it in a manpage offers much benefit. Objections?

Change History (7)

comment:1 by Aymeric Augustin, 10 years ago

It may be useful for downstream e.g. Debian packagers. Can you seek input from downstream maintainers or bring it up on django-developers?

comment:3 by Tim Graham, 10 years ago

Summary: Remove (or update) docs/man/django-admin.1Update docs/man/django-admin.1
Triage Stage: UnreviewedAccepted

On the mailing list thread it was noted that sphinx should be able to build a man page automatically from the reStructuredText documentation.

comment:4 by Sasha Romijn, 10 years ago

Has patch: set
Owner: changed from nobody to Sasha Romijn
Status: newassigned

This turns out to be quite simple to do with Sphinx (once you know how). The resulting manpage looks fine to me, and is entirely autogenerated.

PR (with further details in comment): https://github.com/django/django/pull/4255
As the PR notes, we may need to add some process to ensure we update this timely from Sphinx.

comment:5 by Sasha Romijn, 10 years ago

Owner: Sasha Romijn removed
Status: assignednew

comment:6 by Tim Graham <timograham@…>, 10 years ago

Owner: set to Tim Graham <timograham@…>
Resolution: fixed
Status: newclosed

In f66c2bdc0f056ffcbf6df121ea9132aaa0c4cadb:

Fixed #23903 -- Configured Sphinx to autogenerate django-admin manpage

comment:7 by Tim Graham <timograham@…>, 10 years ago

In 846a970106de41b65dac2fd420055173877255c7:

[1.8.x] Fixed #23903 -- Configured Sphinx to autogenerate django-admin manpage

Backport of f66c2bdc0f056ffcbf6df121ea9132aaa0c4cadb from master

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