Mercurial > p > roundup > code
comparison doc/tracker_templates.txt @ 6728:f83e19465b70
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).
| author | John Rouillard <rouilj@ieee.org> |
|---|---|
| date | Sun, 26 Jun 2022 23:24:04 -0400 |
| parents | 3f3ce3004013 |
| children | 00fe67eb8a91 |
comparison
equal
deleted
inserted
replaced
| 6727:3f3ce3004013 | 6728:f83e19465b70 |
|---|---|
| 9 | 9 |
| 10 The template loading looks in four places to find the templates: | 10 The template loading looks in four places to find the templates: |
| 11 | 11 |
| 12 1. *share* - eg. ``<prefix>/share/roundup/templates/*``. | 12 1. *share* - eg. ``<prefix>/share/roundup/templates/*``. |
| 13 This should be the standard place to find them when Roundup is | 13 This should be the standard place to find them when Roundup is |
| 14 installed. | 14 installed running setup.py from source. |
| 15 2. ``<roundup.admin.__file__>/../templates/*``. | 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/*``. | |
| 16 This will be used if Roundup's run in the distro (aka. source) | 23 This will be used if Roundup's run in the distro (aka. source) |
| 17 directory. | 24 directory. |
| 18 3. ``<current working dir>/*``. | 25 4. ``<current working dir>/*``. |
| 19 This is for when someone unpacks a 3rd-party template. | 26 This is for when someone unpacks a 3rd-party template. |
| 20 4. ``<current working dir>``. | 27 5. ``<current working dir>``. |
| 21 This is for someone who "cd"s to the 3rd-party template dir. | 28 This is for someone who "cd"s to the 3rd-party template dir. |
| 22 | 29 |
| 23 Templates contain: | 30 Templates contain: |
| 24 | 31 |
| 25 - modules ``schema.py`` and ``initial_data.py`` | 32 - modules ``schema.py`` and ``initial_data.py`` |