more docs

Author: bckohan

django_typer/__init__.py

@@ -100,7 +100,15 @@
 __copyright__ = "Copyright 2023-2024 Brian Kohan"
 
 
-__all__ = ["TyperCommand", "Context", "initialize", "command", "group", "get_command"]
+__all__ = [
+    "TyperCommand",
+    "Context",
+    "initialize",
+    "command",
+    "group",
+    "get_command",
+    "model_parser_completer",
+]
 
 
 def model_parser_completer(

django_typer/types.py

@@ -2,7 +2,7 @@
 Common types for command line argument specification.
 """
 
-# pylint: disable=pointless-string-statement
+# pylint: disable=pointless-string-statement, line-too-long
 
 import sys
 from pathlib import Path
@@ -53,9 +53,6 @@ def set_force_color(context, param, value):
     return value
 
 
-"""
-https://docs.djangoproject.com/en/stable/howto/custom-management-commands/#django.core.management.BaseCommand.get_version
-"""
 Version = Annotated[
     bool,
     Option(
@@ -66,10 +63,14 @@ def set_force_color(context, param, value):
         rich_help_panel=COMMON_PANEL,
     ),
 ]
-
 """
-https://docs.djangoproject.com/en/stable/ref/django-admin/#cmdoption-verbosity
+The type hint for the 
+`Django --version option <https://docs.djangoproject.com/en/stable/howto/custom-management-commands/#django.core.management.BaseCommand.get_version>`_.
+
+The --version option is included by default and behaves the same as on BaseCommand_.
 """
+
+
 Verbosity = Annotated[
     int,
     Option(
@@ -83,10 +84,20 @@ def set_force_color(context, param, value):
         rich_help_panel=COMMON_PANEL,
     ),
 ]
-
 """
-https://docs.djangoproject.com/en/stable/ref/django-admin/#cmdoption-settings
+The type hint for the 
+`Django --verbosity option <https://docs.djangoproject.com/en/stable/ref/django-admin/#cmdoption-verbosity>`_.
+:class:`~django_typer.TyperCommand` does not include the verbosity option by default, but it can be
+added to the command like so if needed.
+
+.. code-block:: python
+    
+        from django_typer.types import Verbosity
+    
+        def handle(self, verbosity: Verbosity = 1):
+            ...
 """
+
 Settings = Annotated[
     str,
     Option(
@@ -98,10 +109,15 @@ def set_force_color(context, param, value):
         rich_help_panel=COMMON_PANEL,
     ),
 ]
-
 """
-https://docs.djangoproject.com/en/stable/ref/django-admin/#cmdoption-pythonpath
+The type hint for the 
+`Django --settings option <https://docs.djangoproject.com/en/stable/ref/django-admin/#cmdoption-settings>`_.
+
+The --settings option is included by default and behaves the same as on BaseCommand_ use it to
+specify or override the settings module to use.
 """
+
+
 PythonPath = Annotated[
     Optional[Path],
     Option(
@@ -112,10 +128,15 @@ def set_force_color(context, param, value):
         rich_help_panel=COMMON_PANEL,
     ),
 ]
-
 """
-https://docs.djangoproject.com/en/stable/ref/django-admin/#cmdoption-traceback
+The type hint for the 
+`Django --pythonpath option <https://docs.djangoproject.com/en/stable/ref/django-admin/#cmdoption-pythonpath>`_.
+
+The --pythonpath option is included by default and behaves the same as on BaseCommand_ use it to
+specify a directory to add to the Python sys path.
 """
+
+
 Traceback = Annotated[
     bool,
     Option(
@@ -124,10 +145,15 @@ def set_force_color(context, param, value):
         rich_help_panel=COMMON_PANEL,
     ),
 ]
-
 """
-https://docs.djangoproject.com/en/stable/ref/django-admin/#cmdoption-no-color
+The type hint for the 
+`Django --traceback option <https://docs.djangoproject.com/en/stable/ref/django-admin/#cmdoption-traceback>`_.
+
+The --traceback option is included by default and behaves the same as on BaseCommand_ use it to
+allow CommandError exceptions to propagate out of the command and produce a stack trace.
 """
+
+
 NoColor = Annotated[
     bool,
     Option(
@@ -138,11 +164,15 @@ def set_force_color(context, param, value):
         rich_help_panel=COMMON_PANEL,
     ),
 ]
-
-
 """
-https://docs.djangoproject.com/en/stable/ref/django-admin/#cmdoption-force-color
+The type hint for the 
+`Django --no-color option <https://docs.djangoproject.com/en/stable/ref/django-admin/#cmdoption-no-color>`_.
+
+The --no-color option is included by default and behaves the same as on BaseCommand_ use it to
+force disable colorization of the command. You can check the supplied value of --no-color by
+checking the no_color attribute of the command instance.
 """
+
 ForceColor = Annotated[
     bool,
     Option(
@@ -153,16 +183,28 @@ def set_force_color(context, param, value):
         rich_help_panel=COMMON_PANEL,
     ),
 ]
-
 """
-https://docs.djangoproject.com/en/stable/ref/django-admin/#cmdoption-skip-checks
+The type hint for the 
+`Django --force-color option <https://docs.djangoproject.com/en/stable/ref/django-admin/#cmdoption-force-color>`_.
+
+The --force-color option is included by default and behaves the same as on BaseCommand_ use it to
+force colorization of the command. You can check the supplied value of --force-color by checking
+the force_color attribute of the command instance.
 """
+
 SkipChecks = Annotated[
     bool,
     Option(
         "--skip-checks", help=_("Skip system checks."), rich_help_panel=COMMON_PANEL
     ),
 ]
+"""
+The type hint for the 
+`Django --skip-checks option <https://docs.djangoproject.com/en/stable/ref/django-admin/#cmdoption-skip-checks>`_.
+
+The --skip-checks option is included by default and behaves the same as on BaseCommand_ use it to
+skip system checks.
+"""
 
 
 class Style(ColorStyle):

doc/source/conf.py

@@ -59,7 +59,6 @@
 # This pattern also affects html_static_path and html_extra_path.
 exclude_patterns = []
 
-
 # -- Options for HTML output -------------------------------------------------
 
 # The theme to use for HTML and HTML Help pages.  See the documentation for

doc/source/reference.rst

@@ -15,8 +15,6 @@ django_typer
    :members:
    :undoc-members:
    :show-inheritance:
-   :private-members:
-
 
 .. _types:
 
@@ -77,4 +75,3 @@ shellcompletion
 
 .. automodule:: django_typer.management.commands.shellcompletion
     :members:
-   

doc/source/shell_completion.rst

@@ -2,9 +2,9 @@
 
 .. _shellcompletions:
 
-=================
-Shell Completions
-=================
+=====================
+Shell Tab-Completions
+=====================
 
 .. image:: /_static/img/closepoll_example.gif
    :align: center