Skip to content

Commit 2575715

Browse files
committed
doc: document lib, fix formating/example
Add lib as an optional directory in a template. Make config_ini.ini example an actual code block using the file from the jinja2 template. Format the TEMPLATE-INFO.txt example as plain text (it was highlighting words like 'in' and 'with'). Also move the whole example under the bullet item, it was outside of the list. Reformat the input text to be less than 80 characters.
1 parent 65321bb commit 2575715

File tree

1 file changed

+21
-11
lines changed

1 file changed

+21
-11
lines changed

doc/tracker_templates.txt

Lines changed: 21 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -33,22 +33,32 @@ Templates contain:
3333
- modules ``schema.py`` and ``initial_data.py``
3434
- directories ``html``, ``detectors`` and ``extensions``
3535
(with appropriate contents)
36+
- optional directory ``lib`` which contains modules used by the other
37+
tracker components
3638
- optional ``config_ini.ini`` file. It is structured like a tracker's
3739
``config.ini`` but contains only headers (e.g. ``[main]``) and
38-
*required* parameters that are different from defaults:
39-
e.g. ``template_engine = jinja2`` and ``static_files =
40-
static``. These settings override the default values saved to the
41-
tracker's ``config.ini``.
40+
*required* parameters that are different from defaults. For example::
41+
42+
[main]
43+
template_engine = jinja2
44+
45+
static_files = static
46+
47+
These settings override the default values in the tracker's
48+
``config.ini`` when using roundup-admin to install a template.
4249
- template "marker" file ``TEMPLATE-INFO.txt``, which contains
4350
the name of the template, a description of the template
4451
and its intended audience.
4552

46-
An example TEMPLATE-INFO.txt::
53+
An example TEMPLATE-INFO.txt:
54+
55+
.. code-block:: text
4756

48-
Name: classic
49-
Description: This is a generic issue tracker that may be used to track bugs,
50-
feature requests, project issues or any number of other types
51-
of issues. Most users of Roundup will find that this template
52-
suits them, with perhaps a few customisations.
53-
Intended-For: All first-time Roundup users
57+
Name: classic
58+
Description: This is a generic issue tracker that may be used to
59+
track bugs, feature requests, project issues or any
60+
number of other types of issues. Most users of
61+
Roundup will find that this template suits them,
62+
with perhaps a few customisations.
63+
Intended-For: All first-time Roundup users
5464

0 commit comments

Comments
 (0)