diff options
author | Daniel Baumann <daniel.baumann@progress-linux.org> | 2022-09-16 09:09:35 +0000 |
---|---|---|
committer | Daniel Baumann <daniel.baumann@progress-linux.org> | 2022-09-16 09:09:35 +0000 |
commit | 0dfe1c9e2780469e3a4696e8fb3e6f717a7ebeb7 (patch) | |
tree | a0b651b55ea02e3b00bbc5eedba566fdd6bd7c08 /docs/conf.py | |
parent | Initial commit. (diff) | |
download | terminaltables-0dfe1c9e2780469e3a4696e8fb3e6f717a7ebeb7.tar.xz terminaltables-0dfe1c9e2780469e3a4696e8fb3e6f717a7ebeb7.zip |
Adding upstream version 3.1.0.upstream/3.1.0
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'docs/conf.py')
-rw-r--r-- | docs/conf.py | 53 |
1 files changed, 53 insertions, 0 deletions
diff --git a/docs/conf.py b/docs/conf.py new file mode 100644 index 0000000..fb33f09 --- /dev/null +++ b/docs/conf.py @@ -0,0 +1,53 @@ +"""Sphinx configuration file.""" + +import os +import sys +import time + + +# General configuration. +sys.path.append(os.path.realpath(os.path.join(os.path.dirname(__file__), '..'))) +author = '@Robpol86' +copyright = '{}, {}'.format(time.strftime('%Y'), author) +master_doc = 'index' +project = __import__('setup').NAME +pygments_style = 'friendly' +release = version = __import__('setup').VERSION +templates_path = ['_templates'] +extensions = list() + + +# Options for HTML output. +html_context = dict( + conf_py_path='/docs/', + display_github=True, + github_repo=os.environ.get('TRAVIS_REPO_SLUG', '/' + project).split('/', 1)[1], + github_user=os.environ.get('TRAVIS_REPO_SLUG', 'robpol86/').split('/', 1)[0], + github_version=os.environ.get('TRAVIS_BRANCH', 'master'), + source_suffix='.rst', +) +html_copy_source = False +html_favicon = 'favicon.ico' +html_theme = 'sphinx_rtd_theme' +html_title = project + + +# autodoc +extensions.append('sphinx.ext.autodoc') + + +# extlinks. +extensions.append('sphinx.ext.extlinks') +extlinks = {'github': ('https://github.com/robpol86/{0}/blob/v{1}/%s'.format(project, version), '')} + + +# google analytics +extensions.append('sphinxcontrib.googleanalytics') +googleanalytics_id = 'UA-82627369-1' + + +# SCVersioning. +scv_banner_greatest_tag = True +scv_grm_exclude = ('.gitignore', '.nojekyll', 'README.rst') +scv_show_banner = True +scv_sort = ('semver', 'time') |