Skip to content

Commit bd54ed7

Browse files
authored
Merge pull request piccolo-orm#132 from aminalaee/update-engine-docs-piccolo-conf-example
update-engine-docs-piccolo-conf-example
2 parents af8d2d4 + 094dd97 commit bd54ed7

File tree

1 file changed

+6
-1
lines changed

1 file changed

+6
-1
lines changed

docs/src/piccolo/engines/index.rst

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -95,7 +95,12 @@ variable accordingly.
9595
9696
DB = SQLiteEngine(path='my_test_db.sqlite')
9797
98-
.. hint:: You can also specify sub modules, like `my_module.piccolo_conf`.
98+
If the ``piccolo_conf.py`` file is located in a sub-module (rather than the
99+
root of your project) you can specify the path like this:
100+
101+
.. code-block:: bash
102+
103+
export PICCOLO_CONF=sub_module.piccolo_conf
99104
100105
-------------------------------------------------------------------------------
101106

0 commit comments

Comments
 (0)