Skip to content

Commit 865f048

Browse files
committed
update docs
1 parent 40bf6eb commit 865f048

File tree

6 files changed

+20
-5
lines changed

6 files changed

+20
-5
lines changed

doc/source/changelog.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
Change Log
33
==========
44

5-
v1.6.0 (2025-07-17)
5+
v1.6.0 (2025-07-22)
66
===================
77

88
* Implemented `Allow callback to be specified as import strings. <https://github.com/bckohan/django-routines/issues/54>`_

doc/source/index.rst

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,9 @@ For example, batch together your common database maintenance tasks, deployment r
1212
other set of commands you need to run together. This helps single source general site maintenance
1313
into your settings files keeping your code base DRY_.
1414

15+
If you have ever written one management command that calls other management commands this package
16+
may help you.
17+
1518
:big:`Example`
1619

1720
Let's define two named routines, "package" and "deploy". The package routine will be a collection

doc/source/settings.rst

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,12 @@ Structure
4545
.. autosetting:: django_routines.Routine.continue_on_error
4646
:no-index:
4747

48+
.. autosetting:: django_routines.Routine.initialize
49+
:no-index:
50+
51+
.. autosetting:: django_routines.Routine.finalize
52+
:no-index:
53+
4854
.. autosetting:: django_routines.Routine.pre_hook
4955
:no-index:
5056

@@ -88,7 +94,7 @@ The dictionary can be specified using any combination of these different methods
8894
.. literalinclude:: ../../examples/dict.py
8995
:caption: settings.py
9096
:linenos:
91-
:lines: 3-32
97+
:lines: 3-34
9298

9399
.. tab:: Data Classes
94100

@@ -97,7 +103,7 @@ The dictionary can be specified using any combination of these different methods
97103
.. literalinclude:: ../../examples/dataclasses.py
98104
:caption: settings.py
99105
:linenos:
100-
:lines: 2-35
106+
:lines: 2-37
101107

102108
.. tab:: Functions
103109

@@ -108,4 +114,4 @@ The dictionary can be specified using any combination of these different methods
108114
.. literalinclude:: ../../examples/functions.py
109115
:caption: settings.py
110116
:linenos:
111-
:lines: 2-37
117+
:lines: 2-39

examples/dataclasses.py

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,9 @@
2828
},
2929
subprocess=False, # or True
3030
atomic=False, # or True
31-
continue_on_error=False, # or True
31+
continue_on_error=False, # or True
32+
initialize=None, # or a callable initialize function
33+
finalize=None, # or a callable finalize function
3234
pre_hook=None, # or a callable pre hook function
3335
post_hook=None, # or a callable post hook function
3436
)

examples/dict.py

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,8 @@
2626
"subprocess": False, # or True
2727
"atomic": False, # or True
2828
"continue_on_error": False, # or True
29+
"initialize": None, # or a callable initialize function
30+
"finalize": None, # or a callable finalize function
2931
"pre_hook": None, # or a callable pre hook function
3032
"post_hook": None, # or a callable post hook function
3133
},

examples/functions.py

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,8 @@
1111
subprocess=False, # or True
1212
atomic=False, # or True
1313
continue_on_error=False, # or True
14+
initialize=None, # or a callable initialize function
15+
finalize=None, # or a callable finalize function
1416
pre_hook=None, # or a callable pre hook function
1517
post_hook=None, # or a callable post hook function
1618
)

0 commit comments

Comments
 (0)