reorganize reference

doc/source/changelog.rst

@@ -11,7 +11,7 @@ v3.1.0 (2024-03-xx)
 * Fixed `fish completion installs should respect XDG_CONFIG_HOME <https://github.com/django-commons/django-typer/issues/193>`_
 * Fixed `zsh completion installs should respect ZDOTDIR <https://github.com/django-commons/django-typer/issues/192>`_
 * Implemented `Support Django 5.2 <https://github.com/django-commons/django-typer/issues/188>`_
-* Implemented `Use intersphinx for external document references. <https://github.com/django-commons/django-typer/issues/187>`
+* Implemented `Use intersphinx for external document references. <https://github.com/django-commons/django-typer/issues/187>`_
 * Implemented `Switch poetry -> uv <https://github.com/django-commons/django-typer/issues/185>`_
 * Implemented `Require tests to pass before release action runs. <https://github.com/django-commons/django-typer/issues/173>`_
 

doc/source/index.rst

@@ -196,5 +196,5 @@ the self argument in your commands.**
    shell_completion
    howto
    showcase
-   reference
+   reference/index
    changelog

doc/source/reference/completers.rst

@@ -0,0 +1,25 @@
+.. include:: ../refs.rst
+
+.. _completers:
+
+==========
+Completers
+==========
+
+.. automodule:: django_typer.completers
+    :members:
+
+.. automodule:: django_typer.completers.apps
+    :members:
+
+.. automodule:: django_typer.completers.cmd
+    :members:
+
+.. automodule:: django_typer.completers.db
+    :members:
+
+.. automodule:: django_typer.completers.model
+    :members:
+
+.. automodule:: django_typer.completers.path
+    :members:

doc/source/reference/index.rst

@@ -0,0 +1,23 @@
+.. include:: ../refs.rst
+
+.. _reference:
+
+=========
+Reference
+=========
+
+.. automodule:: django_typer
+
+|
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:
+
+   management
+   types
+   completers
+   parsers
+   shell_completion
+   shells
+   utils

doc/source/reference/management.rst

@@ -0,0 +1,31 @@
+.. include:: ../refs.rst
+
+.. _management:
+
+==========
+Management
+==========
+
+.. autoclass:: django_typer.management.TyperCommand
+    :members:
+    :special-members: __call__
+
+.. automodule:: django_typer.management
+   :members:
+   :exclude-members: Typer, CommandGroup, TyperCommand, Context, CommandNode
+   :show-inheritance:
+
+.. autoclass:: django_typer.management.Context
+    :members:
+
+.. autoclass:: django_typer.management.Typer
+    :members:
+
+.. autoclass:: django_typer.management.TyperParser
+    :members:
+
+.. autoclass:: django_typer.management.CommandNode
+    :members:
+
+.. autoclass:: django_typer.management.TyperCommandMeta
+

doc/source/reference/parsers.rst

@@ -0,0 +1,16 @@
+.. include:: ../refs.rst
+
+.. _parsers:
+
+=======
+Parsers
+=======
+
+.. automodule:: django_typer.parsers
+    :members:
+
+.. automodule:: django_typer.parsers.apps
+    :members:
+
+.. automodule:: django_typer.parsers.model
+    :members:

doc/source/reference/shell_completion.rst

@@ -0,0 +1,10 @@
+.. include:: ../refs.rst
+
+.. _shellcompletion:
+
+================
+Shell Completion
+================
+
+.. automodule:: django_typer.management.commands.shellcompletion
+    :members:

doc/source/reference/shells.rst

@@ -0,0 +1,22 @@
+.. include:: ../refs.rst
+
+.. _shells:
+
+======
+Shells
+======
+
+.. autoclass:: django_typer.shells.bash.BashComplete
+    :members: name, template, color, supports_scripts
+
+.. autoclass:: django_typer.shells.zsh.ZshComplete
+    :members: name, template, color, supports_scripts
+
+.. autoclass:: django_typer.shells.powershell.PowerShellComplete
+    :members: name, template, color, supports_scripts
+
+.. autoclass:: django_typer.shells.powershell.PwshComplete
+    :members: name, template, color, supports_scripts
+
+.. autoclass:: django_typer.shells.fish.FishComplete
+    :members: name, template, color, supports_scripts

doc/source/reference/types.rst

@@ -0,0 +1,11 @@
+.. include:: ../refs.rst
+
+.. _types:
+
+============
+Option Types
+============
+
+.. automodule:: django_typer.types
+    :members:
+

doc/source/reference/utils.rst

@@ -0,0 +1,10 @@
+.. include:: ../refs.rst
+
+.. _utils:
+
+=====
+Utils
+=====
+
+.. automodule:: django_typer.utils
+    :members: model_parser_completer, traceback_config, get_current_command, register_command_plugins, is_method, parse_iso_duration, duration_iso_string