summaryrefslogtreecommitdiff
path: root/docs/build/tutorial.rst
diff options
context:
space:
mode:
authormike bayer <mike_mp@zzzcomputing.com>2021-06-16 15:37:48 +0000
committerGerrit Code Review <gerrit@ci3.zzzcomputing.com>2021-06-16 15:37:48 +0000
commitc97d5b3dd6fde31acb8e9e0c67d0ebc54fa0d809 (patch)
tree46c9ddcaacb373e7e385589713c0b99e9dbd0b52 /docs/build/tutorial.rst
parent05ef8ef16696d66e968c40bec9d54977603b7f14 (diff)
parent7756b35e23ec11b64a1ac37afcb41dda3ca29913 (diff)
downloadalembic-c97d5b3dd6fde31acb8e9e0c67d0ebc54fa0d809.tar.gz
Merge "Revendor editor and make dateutil optional"
Diffstat (limited to 'docs/build/tutorial.rst')
-rw-r--r--docs/build/tutorial.rst9
1 files changed, 6 insertions, 3 deletions
diff --git a/docs/build/tutorial.rst b/docs/build/tutorial.rst
index 84771ad..f575fc7 100644
--- a/docs/build/tutorial.rst
+++ b/docs/build/tutorial.rst
@@ -138,8 +138,10 @@ The file generated with the "generic" configuration looks like::
# (new in 1.5.5)
prepend_sys_path = .
- # timezone to use when rendering the date
- # within the migration file as well as the filename.
+ # timezone to use when rendering the date within the migration file
+ # as well as the filename.
+ # If specified, requires the python-dateutil library that can be
+ # installed by adding `alembic[tz]` to the pip requirements
# string value is passed to dateutil.tz.gettz()
# leave blank for localtime
# timezone =
@@ -254,7 +256,8 @@ This file contains the following features:
* ``timezone`` - an optional timezone name (e.g. ``UTC``, ``EST5EDT``, etc.)
that will be applied to the timestamp which renders inside the migration
- file's comment as well as within the filename. If ``timezone`` is specified,
+ file's comment as well as within the filename. This option requires installing
+ the ``python-dateutil`` library. If ``timezone`` is specified,
the create date object is no longer derived from ``datetime.datetime.now()``
and is instead generated as::