changeset db2eea93e83d in cookiecutter:default details: https://hg.tryton.org/cookiecutter?cmd=changeset;node=db2eea93e83d description: Add documentation template files
issue9636 review339291002 diffstat: {{ cookiecutter.module_name }}/doc/conf.py | 61 +++++++++++++++++++++++++++ {{ cookiecutter.module_name }}/doc/design.rst | 3 + {{ cookiecutter.module_name }}/doc/index.rst | 7 +++ {{ cookiecutter.module_name }}/doc/usage.rst | 3 + {{ cookiecutter.module_name }}/setup.py | 2 +- 5 files changed, 75 insertions(+), 1 deletions(-) diffs (104 lines): diff -r d5c89a0fa160 -r db2eea93e83d {{ cookiecutter.module_name }}/doc/conf.py --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/{{ cookiecutter.module_name }}/doc/conf.py Tue Jan 05 16:34:35 2021 +0000 @@ -0,0 +1,61 @@ +# This file is part of Tryton. The COPYRIGHT file at the top level of +# this repository contains the full copyright notices and license terms. + +modules_url = 'https://docs.tryton.org/projects/modules-{module}/en/{series}/' +trytond_url = 'https://docs.tryton.org/projects/server/en/{series}/' + + +def get_info(): + import configparser + import os + import subprocess + import sys + + module_dir = os.path.dirname(os.path.dirname(__file__)) + + config = configparser.ConfigParser() + config.read_file(open(os.path.join(module_dir, 'tryton.cfg'))) + info = dict(config.items('tryton')) + + result = subprocess.run( + [sys.executable, 'setup.py', '--name'], + stdout=subprocess.PIPE, check=True, cwd=module_dir) + info['name'] = result.stdout.decode('utf-8').strip() + + result = subprocess.run( + [sys.executable, 'setup.py', '--version'], + stdout=subprocess.PIPE, check=True, cwd=module_dir) + version = result.stdout.decode('utf-8').strip() + if 'dev' in version: + info['series'] = 'latest' + else: + info['series'] = '.'.join(version.split('.', 2)[:2]) + + for key in {'depends', 'extras_depend'}: + info[key] = info.get(key, '').strip().splitlines() + info['modules'] = set(info['depends'] + info['extras_depend']) + info['modules'] -= {'ir', 'res'} + + return info + + +info = get_info() + +master_doc = 'index' +project = info['name'] +release = version = info['series'] +default_role = 'ref' +highlight_language = 'none' +extensions = [ + 'sphinx.ext.intersphinx', + ] +intersphinx_mapping = { + 'trytond': (trytond_url.format(series=version), None), + } +intersphinx_mapping.update({ + m: (modules_url.format( + module=m.replace('_', '-'), series=version), None) + for m in info['modules'] + }) + +del get_info, info, modules_url, trytond_url diff -r d5c89a0fa160 -r db2eea93e83d {{ cookiecutter.module_name }}/doc/design.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/{{ cookiecutter.module_name }}/doc/design.rst Tue Jan 05 16:34:35 2021 +0000 @@ -0,0 +1,3 @@ +****** +Design +****** diff -r d5c89a0fa160 -r db2eea93e83d {{ cookiecutter.module_name }}/doc/index.rst --- a/{{ cookiecutter.module_name }}/doc/index.rst Tue Dec 22 19:30:17 2020 +0000 +++ b/{{ cookiecutter.module_name }}/doc/index.rst Tue Jan 05 16:34:35 2021 +0000 @@ -1,2 +1,9 @@ +{{ '#' * (cookiecutter.module_name|replace('_', ' ')|title|length + 7) }} {{ cookiecutter.module_name.replace('_', ' ').title() }} Module {{ '#' * (cookiecutter.module_name|replace('_', ' ')|title|length + 7) }} + +.. toctree:: + :maxdepth: 2 + + usage + design diff -r d5c89a0fa160 -r db2eea93e83d {{ cookiecutter.module_name }}/doc/usage.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/{{ cookiecutter.module_name }}/doc/usage.rst Tue Jan 05 16:34:35 2021 +0000 @@ -0,0 +1,3 @@ +***** +Usage +***** diff -r d5c89a0fa160 -r db2eea93e83d {{ cookiecutter.module_name }}/setup.py --- a/{{ cookiecutter.module_name }}/setup.py Tue Dec 22 19:30:17 2020 +0000 +++ b/{{ cookiecutter.module_name }}/setup.py Tue Jan 05 16:34:35 2021 +0000 @@ -100,7 +100,7 @@ download_url=download_url, project_urls={ "Bug Tracker": 'https://bugs.tryton.org/', - "Documentation": 'https://docs.tryton.org/', + "Documentation": 'https://docs.tryton.org/projects/modules-{{ cookiecutter.module_name|replace('_', '-') }}', "Forum": 'https://www.tryton.org/forum', "Source Code": 'https://hg.tryton.org/modules/{{ cookiecutter.module_name }}', },