diff options
Diffstat (limited to 'docs/internals/contributing')
| -rw-r--r-- | docs/internals/contributing/writing-documentation.txt | 16 |
1 files changed, 16 insertions, 0 deletions
diff --git a/docs/internals/contributing/writing-documentation.txt b/docs/internals/contributing/writing-documentation.txt index 5c8da281ac..a31b1008d8 100644 --- a/docs/internals/contributing/writing-documentation.txt +++ b/docs/internals/contributing/writing-documentation.txt @@ -420,3 +420,19 @@ Translating documentation See :ref:`Localizing the Django documentation <translating-documentation>` if 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``. |