#23903 closed Cleanup/optimization (fixed)
Update docs/man/django-admin.1
| Reported by: | Tim Graham | Owned by: | |
|---|---|---|---|
| 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 , 9 years ago
comment:3 by , 9 years ago
| Summary: | Remove (or update) docs/man/django-admin.1 → Update docs/man/django-admin.1 |
|---|---|
| Triage Stage: | Unreviewed → Accepted |
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 , 9 years ago
| Has patch: | set |
|---|---|
| Owner: | changed from to |
| Status: | new → assigned |
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 , 9 years ago
| Owner: | removed |
|---|---|
| Status: | assigned → new |
comment:6 by , 9 years ago
| Owner: | set to |
|---|---|
| Resolution: | → fixed |
| Status: | new → closed |
Note:
See TracTickets
for help on using tickets.
It may be useful for downstream e.g. Debian packagers. Can you seek input from downstream maintainers or bring it up on django-developers?