Fixed #23903 -- Configured Sphinx to autogenerate django-admin manpage
This commit is contained in:
parent
cefbbb9db3
commit
f66c2bdc0f
|
@ -273,7 +273,7 @@ latex_documents = [
|
||||||
# One entry per manual page. List of tuples
|
# One entry per manual page. List of tuples
|
||||||
# (source start file, name, description, authors, manual section).
|
# (source start file, name, description, authors, manual section).
|
||||||
man_pages = [
|
man_pages = [
|
||||||
('contents', 'django', 'Django Documentation', ['Django Software Foundation'], 1)
|
('ref/django-admin', 'django-admin', 'Utility script for the Django Web framework', ['Django Software Foundation'], 1),
|
||||||
]
|
]
|
||||||
|
|
||||||
|
|
||||||
|
|
|
@ -420,3 +420,19 @@ Translating documentation
|
||||||
|
|
||||||
See :ref:`Localizing the Django documentation <translating-documentation>` if
|
See :ref:`Localizing the Django documentation <translating-documentation>` if
|
||||||
you'd like to help translate the documentation into another language.
|
you'd like to help translate the documentation into another language.
|
||||||
|
|
||||||
|
.. _django-admin-manpage:
|
||||||
|
|
||||||
|
``django-admin`` man page
|
||||||
|
-------------------------
|
||||||
|
|
||||||
|
Sphinx can generate a manual page for the
|
||||||
|
:doc:`django-admin </ref/django-admin>` command. This is configured in
|
||||||
|
``docs/conf.py``. Unlike other documentation output, this man page should be
|
||||||
|
included in the Django repository and the releases as
|
||||||
|
``docs/man/django-admin.1``. There isn't a need to update this file when
|
||||||
|
updating the documentation, as it's updated once as part of the release process.
|
||||||
|
|
||||||
|
To generate an updated version of the man page, run ``make man`` in the
|
||||||
|
``docs`` directory. The new man page will be written in
|
||||||
|
``docs/_build/man/django-admin.1``.
|
||||||
|
|
|
@ -123,6 +123,15 @@ any time leading up to the actual release:
|
||||||
are validation errors which need to be debugged, so avoid doing this task
|
are validation errors which need to be debugged, so avoid doing this task
|
||||||
immediately before a release is needed.
|
immediately before a release is needed.
|
||||||
|
|
||||||
|
#. :ref:`Update the django-admin manual page <django-admin-manpage>`::
|
||||||
|
|
||||||
|
$ cd docs
|
||||||
|
$ make man
|
||||||
|
$ man _build/man/django-admin.1 # do a quick sanity check
|
||||||
|
$ cp _build/man/django-admin.1 man/django-admin.1
|
||||||
|
|
||||||
|
and then commit the changed man page.
|
||||||
|
|
||||||
Preparing for release
|
Preparing for release
|
||||||
=====================
|
=====================
|
||||||
|
|
||||||
|
|
File diff suppressed because it is too large
Load Diff
Loading…
Reference in New Issue