fix #221

Author: bckohan

doc/source/changelog.rst

@@ -4,6 +4,11 @@
 Change Log
 ==========
 
+v3.2.1 (2025-07-16)
+===================
+
+* Docs `Add django-admin role for shellcompletion reference. <https://github.com/django-commons/django-typer/issues/221>`_
+
 v3.2.0 (2025-05-31)
 ===================
 

doc/source/conf.py

@@ -118,7 +118,7 @@ def setup(app):
     # app.connect('html-page-context', add_page_class)
 
     app.add_directive("literalinclude", ExtendedLiteralInclude)
-    
+    app.add_crossref_type(directivename="django-admin", rolename="django-admin")
     # https://sphinxcontrib-typer.readthedocs.io/en/latest/howto.html#build-to-multiple-formats
     if Path(app.doctreedir).exists():
         shutil.rmtree(app.doctreedir)

doc/source/reference/shell_completion.rst

@@ -6,5 +6,7 @@
 Shell Completion
 ================
 
+.. django-admin:: shellcompletion
+
 .. automodule:: django_typer.management.commands.shellcompletion
     :members:

doc/source/shell_completion.rst

@@ -53,10 +53,10 @@ for django commands we need to register our completion logic for Django manage s
 the shell. This process has two phases:
 
 1. Ensure that your shell is configured to support completions.
-2. Use the :mod:`~django_typer.management.commands.shellcompletion` command to install the
-   completion hook for your Django manage script. This usually entails adding a specifically
-   named script to a certain directory or adding lines to an existing profile. The
-   :mod:`~django_typer.management.commands.shellcompletion` command will handle this for you.
+2. Use the :django-admin:`shellcompletion` command to install the completion hook for your Django
+   manage script. This usually entails adding a specifically named script to a certain directory or
+   adding lines to an existing profile. The :django-admin:`shellcompletion` command will handle this
+   for you.
 
 
 The goal of this guide is not to be an exhaustive list of how to enable completions for each
@@ -126,9 +126,8 @@ or have solutions, please `report them on our discussions page <https://github.c
 Install the Completion Hook
 ---------------------------
 
-django-typer_ comes with a management command called
-:mod:`~django_typer.management.commands.shellcompletion`. To install completions for your Django_
-project simply run the install command:
+django-typer_ comes with a management command called :django-admin:`shellcompletion`. To install
+completions for your Django_ project simply run the install command:
 
 .. code-block:: bash
 
@@ -145,8 +144,7 @@ will make and ask for permission before proceeding. To skip the prompt use** ``-
 
 The installation script should be able to automatically detect your shell and install the
 appropriate scripts. If it is unable to do so you may force it to install for a specific shell by
-passing the shell name as an argument. Refer to the
-:mod:`~django_typer.management.commands.shellcompletion` for details.
+passing the shell name as an argument. Refer to the :django-admin:`shellcompletion` for details.
 
 **After installation you will need to restart your shell or source the appropriate rc file.**
 

pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "django-typer"
-version = "3.2.0"
+version = "3.2.1"
 requires-python = ">=3.9,<4.0"
 description = "Use Typer to define the CLI for your Django management commands."
 authors = [

src/django_typer/__init__.py

@@ -33,7 +33,7 @@
 and keep a tight version lock on Typer.
 """
 
-VERSION = (3, 2, 0)
+VERSION = (3, 2, 1)
 
 __title__ = "Django Typer"
 __version__ = ".".join(str(i) for i in VERSION)

src/django_typer/management/__init__.py

@@ -2602,7 +2602,7 @@ def command2(self, option: t.Optional[str] = None):
         - Using `rich_markup_mode
           <https://typer.tiangolo.com/tutorial/commands/help/#rich-markdown-and-markup>`_
           to enable markdown rendering in help output.
-        - Using the chain parameter to enable :ref:`click:multi-command-chaining`.
+        - Using the chain parameter to enable :ref:`click:command-chaining`.
 
 
     We can see that our help renders like so: