Skip to content

Commit 31d7e7f

Browse files
committed
Add new location where templates and locales are found.
Needed to document the 'pip install' location of the templates/locales and other shared files (e.g. man pages).
1 parent 039db69 commit 31d7e7f

File tree

1 file changed

+11
-4
lines changed

1 file changed

+11
-4
lines changed

doc/tracker_templates.txt

Lines changed: 11 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -11,13 +11,20 @@ The template loading looks in four places to find the templates:
1111

1212
1. *share* - eg. ``<prefix>/share/roundup/templates/*``.
1313
This should be the standard place to find them when Roundup is
14-
installed.
15-
2. ``<roundup.admin.__file__>/../templates/*``.
14+
installed running setup.py from source.
15+
2. ``install_dir``/../<prefix>/share/....``, where prefix is the
16+
Python's ``sys.prefix``. This finds templates (and locales)
17+
installed by pip. E.G. in a virtualenv located at (``sys.prefix``):
18+
``/tools/roundup``, roundup would be at:
19+
``/tools/roundup/lib/python3.6/site-packages/roundup``. The
20+
templates would be at:
21+
``/tools/roundup/lib/python3.6/site-packages/tools/roundup/share/roundup/templates/``.
22+
3. ``<roundup.admin.__file__>/../templates/*``.
1623
This will be used if Roundup's run in the distro (aka. source)
1724
directory.
18-
3. ``<current working dir>/*``.
25+
4. ``<current working dir>/*``.
1926
This is for when someone unpacks a 3rd-party template.
20-
4. ``<current working dir>``.
27+
5. ``<current working dir>``.
2128
This is for someone who "cd"s to the 3rd-party template dir.
2229

2330
Templates contain:

0 commit comments

Comments
 (0)