##// END OF EJS Templates
docs: reorganize index page...
docs: reorganize index page Reorganize the index page of the manual into three main sections: administrator guide, user guide, developer guide. In principle, administrators, users and developers are independent roles that can be fulfilled by different people. 'Administrators' install, configure and maintain Kallithea. They have 'admin' privilege in the web interface. 'Users' do not have access to the Kallithea installation files. They can only access the web interface, and generally do not have 'admin' privilege. They may be the owner of repositories, repository groups, or user groups, and as such modify the settings of these objects, even though they cannot modify the settings of Kallithea itself. 'Developers' modify the Kallithea source code. They may or may not contribute these changes back to the Kallithea community. The 'Readme' section is a bit outside of this classification. As it serves as a basic introduction to Kallithea, it is kept first. The 'Index' and 'Search' functionality are not really 'part of' the manual, so should not be under 'Other topics'. Instead they are put at the very top so they are readily visible. This commit is only changing the index page. Subsequent commits can move and split some documentation files in the repository to mirror this structure. For example, the 'Version control systems support' page has information for administrators (ini settings and importing existing repositories) as well as for users (handling Mercurial subrepositories).

File last commit:

r7189:52544ad8 default
r7254:e71216a1 default
Show More
generate-ini.py
74 lines | 2.0 KiB | text/x-python | PythonLexer
Mads Kiilerich
ini: add scripts/generate-ini.py for generating all .ini files from template.ini.mako...
r5536 #!/usr/bin/env python2
"""
Mads Kiilerich
gearbox: make a make-config sub-command available again...
r6510 Based on kallithea/lib/paster_commands/template.ini.mako, generate
Mads Kiilerich
ini: add scripts/generate-ini.py for generating all .ini files from template.ini.mako...
r5536 development.ini
kallithea/tests/test.ini
"""
import re
Mads Kiilerich
ini: extract .ini handling from scripts/generate-ini.py to kallithea/lib/inifile.py...
r6809 from kallithea.lib import inifile
Mads Kiilerich
ini: add scripts/generate-ini.py for generating all .ini files from template.ini.mako...
r5536 # files to be generated from the mako template
ini_files = [
('development.ini',
{
'[server:main]': {
'host': '0.0.0.0',
},
'[app:main]': {
Thomas De Schampheleire
ini: set 'debug' only in one place...
r6526 'debug': 'true',
Mads Kiilerich
ini: add scripts/generate-ini.py for generating all .ini files from template.ini.mako...
r5536 'app_instance_uuid': 'development-not-secret',
'beaker.session.secret': 'development-not-secret',
},
'[handler_console]': {
'formatter': 'color_formatter',
},
'[handler_console_sql]': {
'formatter': 'color_formatter_sql',
},
domruf
ini: set default log level to WARN...
r7118 '[logger_routes]': {
'level': 'DEBUG',
},
'[logger_beaker]': {
'level': 'DEBUG',
},
'[logger_templates]': {
'level': 'INFO',
},
'[logger_kallithea]': {
'level': 'DEBUG',
},
'[logger_tg]': {
'level': 'DEBUG',
},
'[logger_gearbox]': {
'level': 'DEBUG',
},
'[logger_whoosh_indexer]': {
'level': 'DEBUG',
},
Mads Kiilerich
ini: add scripts/generate-ini.py for generating all .ini files from template.ini.mako...
r5536 },
),
]
def main():
# make sure all mako lines starting with '#' (the '##' comments) are marked up as <text>
Mads Kiilerich
ini: move high level functionality and defaults to inifiles library
r6819 makofile = inifile.template_file
Mads Kiilerich
ini: add scripts/generate-ini.py for generating all .ini files from template.ini.mako...
r5536 print 'reading:', makofile
Lars Kruse
py3: replace "file" with "open"
r6785 mako_org = open(makofile).read()
Mads Kiilerich
ini: add scripts/generate-ini.py for generating all .ini files from template.ini.mako...
r5536 mako_no_text_markup = re.sub(r'</?%text>', '', mako_org)
mako_marked_up = re.sub(r'\n(##.*)', r'\n<%text>\1</%text>', mako_no_text_markup, flags=re.MULTILINE)
if mako_marked_up != mako_org:
print 'writing:', makofile
Lars Kruse
py3: replace "file" with "open"
r6785 open(makofile, 'w').write(mako_marked_up)
Mads Kiilerich
ini: add scripts/generate-ini.py for generating all .ini files from template.ini.mako...
r5536
# create ini files
Mads Kiilerich
ini: drop insertion of header comments in generated ini files...
r6818 for fn, settings in ini_files:
Mads Kiilerich
ini: add scripts/generate-ini.py for generating all .ini files from template.ini.mako...
r5536 print 'updating:', fn
Mads Kiilerich
ini: move high level functionality and defaults to inifiles library
r6819 inifile.create(fn, None, settings)
Mads Kiilerich
ini: add scripts/generate-ini.py for generating all .ini files from template.ini.mako...
r5536
if __name__ == '__main__':
main()