[Django] #23903: Remove (or update) docs/man/django-admin.1
Django
------------------------------------------------+------------------------
Reporter: timgraham | Owner: nobody
Type: Cleanup/optimization | Status: new
Component: Documentation | Version: master
Severity: Normal | Keywords:
Triage Stage: Unreviewed | Has patch: 0
Needs documentation: 0 | Needs tests: 0
Patch needs improvement: 0 | Easy pickings: 0
UI/UX: 0 |
------------------------------------------------+------------------------
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?
--
Ticket URL: <https://code.djangoproject.com/ticket/23903>
Django <https://code.djangoproject.com/>
The Web framework for perfectionists with deadlines.
Django
Reporter: timgraham | Owner: nobody
Type: | Status: new
Cleanup/optimization | Version: master
Component: Documentation | Resolution:
Severity: Normal | Triage Stage:
Keywords: | Unreviewed
Has patch: 0 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
Comment (by aaugustin):
It may be useful for downstream e.g. Debian packagers. Can you seek input
from downstream maintainers or bring it up on django-developers?
--
Ticket URL: <https://code.djangoproject.com/ticket/23903#comment:1>
Django
Reporter: timgraham | Owner: nobody
Type: | Status: new
Cleanup/optimization | Version: master
Component: Documentation | Resolution:
Severity: Normal | Triage Stage:
Has patch: 0 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
Comment (by timgraham):
Created [https://groups.google.com/d/topic/django-
developers/CzYYW8s2Lfg/discussion django-developers thread].
--
Ticket URL: <https://code.djangoproject.com/ticket/23903#comment:2>
Django
--------------------------------------+------------------------------------
Reporter: timgraham | Owner: nobody
Type: Cleanup/optimization | Status: new
Component: Documentation | Version: master
Keywords: | Triage Stage: Accepted
Has patch: 0 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
Changes (by timgraham):
* stage: Unreviewed => Accepted
Comment:
On the mailing list thread it was noted that sphinx should be able to
build a man page automatically from the reStructuredText documentation.
--
Ticket URL: <https://code.djangoproject.com/ticket/23903#comment:3>
Django
--------------------------------------+------------------------------------
Reporter: timgraham | Owner: erikr
Type: Cleanup/optimization | Status: assigned
Component: Documentation | Version: master
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
Changes (by erikr):
* owner: nobody => erikr
* status: new => assigned
* has_patch: 0 => 1
Comment:
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.
--
Ticket URL: <https://code.djangoproject.com/ticket/23903#comment:4>
Django
--------------------------------------+------------------------------------
Reporter: timgraham | Owner:
Component: Documentation | Version: master
Keywords: | Triage Stage: Accepted
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
Changes (by erikr):
* owner: erikr =>
* status: assigned => new
--
Ticket URL: <https://code.djangoproject.com/ticket/23903#comment:5>
Django
-------------------------------------+-------------------------------------
Reporter: timgraham | Owner: Tim
Type: | Graham <timograham@…>
Cleanup/optimization | Status: closed
Component: Documentation | Version: master
Severity: Normal | Resolution: fixed
Keywords: | Triage Stage: Accepted
Has patch: 1 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
Changes (by Tim Graham <timograham@…>):
* owner: => Tim Graham <timograham@…>
* status: new => closed
* resolution: => fixed
Comment:
In [changeset:"f66c2bdc0f056ffcbf6df121ea9132aaa0c4cadb"]:
{{{
#!CommitTicketReference repository=""
revision="f66c2bdc0f056ffcbf6df121ea9132aaa0c4cadb"
Fixed #23903 -- Configured Sphinx to autogenerate django-admin manpage
}}}
--
Ticket URL: <https://code.djangoproject.com/ticket/23903#comment:6>
Django
-------------------------------------+-------------------------------------
Reporter: timgraham | Owner: Tim
Type: | Graham <timograham@…>
Cleanup/optimization | Status: closed
Severity: Normal | Resolution: fixed
Keywords: | Triage Stage: Accepted
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
Comment (by Tim Graham <timograham@…>):
In [changeset:"846a970106de41b65dac2fd420055173877255c7"]:
{{{
#!CommitTicketReference repository=""
revision="846a970106de41b65dac2fd420055173877255c7"
[1.8.x] Fixed #23903 -- Configured Sphinx to autogenerate django-admin
manpage
Backport of f66c2bdc0f056ffcbf6df121ea9132aaa0c4cadb from master
}}}
--
Ticket URL: <https://code.djangoproject.com/ticket/23903#comment:7>