add tabs to docs

Author: bckohan

django_typer/__init__.py

@@ -1322,6 +1322,7 @@ def __getattr__(self, name: str) -> t.Any:
         """
         if hasattr(self.proxied, name):
             attr = getattr(self.proxied, name)
+            # want to avoid recursive binding
             if isinstance(attr, (Typer, typer.models.CommandInfo)):
                 return BoundProxy(self.command, attr)
             return attr
@@ -1332,6 +1333,9 @@ def __getattr__(self, name: str) -> t.Any:
             )
         )
 
+    # def __repr__(self) -> str:
+    #     return f'<{self.__class__.__module__}.{self.__class__.__name__} for {repr(self.proxied)}>'
+
 
 def initialize(
     name: t.Optional[str] = Default(None),

doc/source/conf.py

@@ -50,7 +50,8 @@
     'sphinx_rtd_theme',
     'sphinx.ext.autodoc',
     'sphinx.ext.todo',
-    'sphinxcontrib.typer'
+    'sphinxcontrib.typer',
+    'sphinx_tabs.tabs'
 ]
 
 # Add any paths that contain templates here, relative to this directory.

doc/source/index.rst

@@ -54,58 +54,73 @@ replacement.
 
    *You only need to install django_typer as an app if you want to use the shellcompletion command
    to enable tab-completion or if you would like django-typer to install*
-   :ref:`rich traceback rendering <configure-rich-exception-tracebacks>` *for you - which it does by
-   default if rich is also installed.*
+   :ref:`rich traceback rendering <configure-rich-exception-tracebacks>` *for you - which it does
+   by default if rich is also installed.*
+
+.. note::
+
+    This documentation shows all examples using both the function orientied Typer-style interface
+    and the class based Django-style interface using tabs. Each interface is equivalent so the
+    choice of which to use is a matter of preference.
 
 :big:`Basic Example`
 
 For example TyperCommands can be a very simple drop in replacement for BaseCommands. All of the
-documented features of BaseCommand_ work!
+documented features of BaseCommand_ work! Or, you may also use an interface identitical to Typer's.
+Simply import Typer from django_typer instead of typer.
 
+.. tabs::
 
-.. literalinclude:: ../../django_typer/tests/apps/examples/basic/management/commands/basic.py
-   :language: python
-   :caption: A Basic Command
-   :linenos:
+    .. tab:: Django-style
 
-Or, you may also use an interface identitical to Typer's. Simply import Typer from django_typer
-instead of typer:
+        .. literalinclude:: ../../django_typer/tests/apps/examples/basic/management/commands/basic.py
+            :language: python
+            :caption: management/commands/basic.py
+            :linenos:
 
-.. literalinclude:: ../../django_typer/tests/apps/examples/typer/management/commands/basic.py
-   :language: python
-   :caption: A Typer-style Basic Command
-   :linenos:
+    .. tab:: Typer-style
+
+        .. literalinclude:: ../../django_typer/tests/apps/examples/typer/management/commands/basic.py
+            :language: python
+            :caption: management/commands/basic.py
+            :linenos:
 
 
 .. typer:: django_typer.tests.apps.examples.basic.management.commands.basic.Command:typer_app
     :prog: ./manage.py basic
     :width: 80
     :convert-png: latex
+    :theme: dark
 
 |
 
 :big:`Multiple Subcommands Example`
 
 Commands with multiple subcommands can be defined:
 
-.. literalinclude:: ../../django_typer/tests/apps/examples/basic/management/commands/multi.py
-   :language: python
-   :caption: A Command w/Subcommands
-   :linenos:
+.. tabs::
+
+    .. tab:: Django-style
 
-Or using the typer-style interface this could be written:
+        .. literalinclude:: ../../django_typer/tests/apps/examples/basic/management/commands/multi.py
+            :language: python
+            :caption: management/commands/multi.py
+            :linenos:
 
-.. literalinclude:: ../../django_typer/tests/apps/examples/typer/management/commands/multi.py
-   :language: python
-   :caption: A Typer-style Command w/Subcommands
-   :linenos:
+    .. tab:: Typer-style
+
+        .. literalinclude:: ../../django_typer/tests/apps/examples/typer/management/commands/multi.py
+            :language: python
+            :caption: management/commands/multi.py
+            :linenos:
 
 
 .. typer:: django_typer.tests.apps.examples.basic.management.commands.multi.Command:typer_app
     :prog: ./manage.py multi
     :width: 80
     :show-nested:
     :convert-png: latex
+    :theme: dark
 
 |
 
@@ -124,29 +139,33 @@ command like so:
     ./manage.py hierarchy math multiply 10 2
     20.00
 
-Any number of groups and subcommands and subgroups of other groups can be defined allowing
-for arbitrarily complex command hierarchies. Using the class-based interface we could define
-the command like this:
+Any number of groups and subcommands and subgroups of other groups can be defined allowing for
+arbitrarily complex command hierarchies. The Typer-style interface builds a TyperCommand class for
+us. **This allows you to optionally accept the self argument in your commands.** We could define
+the above command using the typer interface like this:
+
+.. tabs::
+
+    .. tab:: Django-style
 
-.. literalinclude:: ../../django_typer/tests/apps/examples/basic/management/commands/hierarchy.py
-   :language: python
-   :caption: A Command w/Grouping Hierarchy
-   :linenos:
+        .. literalinclude:: ../../django_typer/tests/apps/examples/basic/management/commands/hierarchy.py
+            :language: python
+            :caption: management/commands/hierarchy.py
+            :linenos:
 
-The typer-style interface builds a TyperCommand class for us. This allows you to optionally
-accept the self argument in your commands. We could define the above command using the typer
-interface like this:
+    .. tab:: Typer-style
 
-.. literalinclude:: ../../django_typer/tests/apps/examples/typer/management/commands/hierarchy.py
-   :language: python
-   :caption: A Typer-style Command w/Grouping Hierarchy
-   :linenos:
+        .. literalinclude:: ../../django_typer/tests/apps/examples/typer/management/commands/hierarchy.py
+            :language: python
+            :caption: management/commands/hierarchy.py
+            :linenos:
 
 .. typer:: django_typer.tests.apps.examples.basic.management.commands.hierarchy.Command:typer_app
     :prog: ./manage.py hierarchy
     :width: 80
     :show-nested:
     :convert-png: latex
+    :theme: dark
 
 |
 

doc/source/reference.rst

@@ -23,7 +23,7 @@ django_typer
     :members: initialize, callback, command, group, echo, secho, print_help, get_subcommand
 
 .. autoclass:: django_typer.CommandNode
-    :members: name, click_command, context, parent, children, get_command, print_help
+    :members: name, click_command, context, children, get_command, print_help
 
 .. autoclass:: django_typer.TyperCommandMeta
 

pyproject.toml

@@ -73,7 +73,7 @@ pylint = "^3.0"
 doc8 = "^1.1.1"
 aiohttp = "^3.9.1"
 readme-renderer = {extras = ["md"], version = ">=42,<44"}
-sphinxcontrib-typer = {extras = ["html", "pdf", "png"], version = "^0.2.3", markers="python_version >= '3.9'"}
+sphinxcontrib-typer = {extras = ["html", "pdf", "png"], version = "^0.2.5", markers="python_version >= '3.9'"}
 scikit-learn = "^1.0.0"
 pytest-env = "^1.0.0"
 numpy = [
@@ -89,6 +89,7 @@ pexpect = "^4.9.0"
 pyright = "^1.1.357"
 ruff = "^0.4.1"
 graphviz = "^0.20.3"
+sphinx-tabs = "^3.4.5"
 
 [tool.poetry.extras]
 rich = ["rich"]