From 9c3fb9b52a09a67da9a838e44b65e4a5f3b0c9bf Mon Sep 17 00:00:00 2001 From: Brian Kohan Date: Wed, 20 Nov 2024 20:51:02 -0800 Subject: [PATCH] fix #142 --- doc/source/_static/showcase.css | 3 +++ doc/source/changelog.rst | 1 + doc/source/index.rst | 1 + doc/source/showcase.rst | 33 +++++++++++++++++++++++++++++++++ 4 files changed, 38 insertions(+) create mode 100644 doc/source/_static/showcase.css create mode 100644 doc/source/showcase.rst diff --git a/doc/source/_static/showcase.css b/doc/source/_static/showcase.css new file mode 100644 index 0000000..d2de49f --- /dev/null +++ b/doc/source/_static/showcase.css @@ -0,0 +1,3 @@ +table th:first-child, table td:first-child { + white-space: nowrap; +} diff --git a/doc/source/changelog.rst b/doc/source/changelog.rst index c24dcff..c5cd0b9 100644 --- a/doc/source/changelog.rst +++ b/doc/source/changelog.rst @@ -7,6 +7,7 @@ v3.0.0 (202X-XX-XX) * Fixed `Typer-style interface throws an assertion when no callback is present on a subgroup. `_ * Fixed `supressed_base_arguments are still present in the Context `_ +* Implemented `Add showcase of commands using django-typer to docs `_ * Implemented `Add a @finalize decorator for functions to collect/operate on subroutine results. `_ * Fixed `Remove management imports in django_typer/__init__.py `_ diff --git a/doc/source/index.rst b/doc/source/index.rst index c48f3f6..5ac663e 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -193,5 +193,6 @@ the self argument in your commands.** extensions shell_completion howto + showcase reference changelog diff --git a/doc/source/showcase.rst b/doc/source/showcase.rst new file mode 100644 index 0000000..670006a --- /dev/null +++ b/doc/source/showcase.rst @@ -0,0 +1,33 @@ +.. include:: ./refs.rst + +.. raw:: html + + + +======== +Showcase +======== + +These packages provide management commands that have been implemented using django-typer_. If you +would like us to showcase a package, +`please submit a PR `_. + +.. note:: + + The following packages are not maintained by the django-typer_ project. If you have any issues + with the packages, please contact the package maintainers. + +---------------- + +.. list-table:: + :header-rows: 1 + + * - Package + - Description + * - `django-tailwind-cli `_ + - Django and Tailwind integration based on the prebuilt Tailwind CSS CLI. + * - `django-render-static `_ + - Use Django's template engines to render static files at deployment or package time. Includes + transpilers for extending Django's url reversal and enums to JavaScript. + * - `django-routines `_ + - Define named sequences of management commands in Django settings files for batched execution.