Modify ↓
#13271 closed enhancement (fixed)
Improve documentation for [project] url and [trac] base_url
Reported by: | Ryan J Ollos | Owned by: | Ryan J Ollos |
---|---|---|---|
Priority: | normal | Milestone: | 1.5.1 |
Component: | general | Version: | |
Severity: | normal | Keywords: | |
Cc: | Branch: | ||
Release Notes: | |||
API Changes: | |||
Internal Changes: |
Improved TracIni documentation for |
Description
Discussed in gmessage:trac-users:eg9APtcEUiU/2V451tnuFgAJ. Minor changes proposed:
-
trac/env.py
diff --git a/trac/env.py b/trac/env.py index 32581f1fe..1cc0a15c2 100644
a b class Environment(Component, ComponentManager): 131 131 """) 132 132 133 133 base_url = Option('trac', 'base_url', '', 134 """ Reference URL for the Trac deployment.134 """Base URL of the Trac site. 135 135 136 This is the base URL that will be used when producing137 documents that will be used outside of the web browsing138 context, like for example when inserting URLs pointing to Trac139 resources in notification e-mails.""")136 This is used to produce documents outside of the web browsing 137 context, such as URLs in notification e-mails that point to 138 Trac resources. 139 """) 140 140 141 141 base_url_for_redirect = BoolOption('trac', 'use_base_url_for_redirect', 142 142 False, … … class Environment(Component, ComponentManager): 173 173 """Short description of the project.""") 174 174 175 175 project_url = Option('project', 'url', '', 176 """URL of the main project web site, usually the website in 177 which the `base_url` resides. This is used in notification 178 e-mails.""") 176 """URL of the project web site. 177 178 This is usually the domain in which the `base_url` resides. 179 For example, the project URL might be https://myproject.com, 180 with the Trac site (`base_url`) residing at either 181 https://trac.myproject.com or https://myproject.com/trac. 182 The project URL is added to the footer of notification e-mails. 183 """) 179 184 180 185 project_admin = Option('project', 'admin', '', 181 186 """E-Mail address of the project's administrator.""")
Attachments (0)
Change History (2)
comment:1 by , 5 years ago
Release Notes: | modified (diff) |
---|---|
Resolution: | → fixed |
Status: | assigned → closed |
comment:2 by , 4 years ago
Note:
See TracTickets
for help on using tickets.
Committed to trunk in r17272. New extraction in r17273.