# The encoding of source files.
source_encoding = 'utf-8-sig'
# The master toctree document.
master_doc = 'index'
# To get rid of the ¶ sign on descriptions over a box
html_add_permalinks = ""
# The version info for the project you're documenting, acts as replacement for
# |version| and |release|, also used in various other places throughout the
# built documents.
#
# The short X.Y version.
#version = '1.3c'
version = shngversion.get_shng_main_version()
# General information about the project.
#project = u'SmartHomeNG'
project = u'Developer Documentation v' + version
#copyright = u'2011-2013, Marcus Popp; since 2016 SmartHomeNG Team'
#copyright = u'2016-2017 SmartHomeNG Team, based on smarthome.py © 2011-2014 Marcus Popp'
copyright = u'2016-2020 SmartHomeNG Team, SmartHomeNG is based on smarthome.py © Marcus Popp'
if os.path.isfile(os.getcwd() + '/doc_version.flg'):
release = '1.4.x'
with open(os.getcwd() + '/doc_version.flg', encoding='UTF-8') as f:
release = f.readline()
branch = 'master'
commit = ''
comit_short = ''
# To get rid of the ¶ sign on descriptions over a box
html_add_permalinks = ""
# General information about the project.
#project = u'SmartHomeNG'
project = u'Developer Documentation'
#copyright = u'2011-2013, Marcus Popp; since 2016 SmartHomeNG Team'
copyright = u'2016-2017 SmartHomeNG Team, based on smarthome.py © 2011-2014 Marcus Popp'
# The version info for the project you're documenting, acts as replacement for
# |version| and |release|, also used in various other places throughout the
# built documents.
#
# The short X.Y version.
#version = '1.3c'
version = shngversion.get_shng_main_version()
# The full version, including alpha/beta/rc tags.
#release = '1.3a dev (as of 13. October 2017)' 13. October 2017 is replaced by makefile with a date in the form of '2. September 2017'
#release = '1.3c dev (as of 13. October 2017)'
release = shngversion.get_shng_docversion() + ' (as of ' + today
commit, commit_short, branch, describe = shngversion._get_git_data()
if branch != 'master':
release += ', commit '+commit_short
release += ')'
#release = sphinx_bootstrap_theme.__version__
# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
#language = None
#for multi language (of developer documentation)
#language = 'en'
