otc-metadata/otc_metadata/templates/conf.py.j2

# Licensed under the Apache License, Version 2.0 (the "License"); you may
# not use this file except in compliance with the License. You may obtain
# a copy of the License at
#
#    http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
# License for the specific language governing permissions and limitations
# under the License.
#
# !!!
# This file is generated out of template in doc-exports repository.
# Beware overwriting it locally.

import os
import sys
from git import Repo
from datetime import datetime

extensions = [
    'otcdocstheme',
{%- if otc_sbv %}
    'otc_sphinx_directives'
{%- endif %}
]

otcdocs_auto_name = False
otcdocs_auto_version = False

project = '{{ project }}'
otcdocs_repo_name = '{{ repo_name }}'
# Those variables are required for edit/bug links
{%- if git_fqdn %}
otcdocs_git_fqdn = '{{ git_fqdn }}'
{%- endif %}
{%- if git_type %}
otcdocs_git_type = '{{ git_type }}'
{%- endif %}

# Those variables are needed for indexing into OpenSearch
otcdocs_doc_environment = '{{ doc_environment }}'
otcdocs_doc_link = '{{ doc_link }}'
otcdocs_doc_title = '{{ doc_title }}'
otcdocs_doc_type = '{{ doc_type }}'
otcdocs_service_category = '{{ service_category }}'
otcdocs_service_title = '{{ service_title }}'
otcdocs_service_type = '{{ service_type }}'
otcdocs_search_environment = 'hc_de'
otcdocs_search_url = "https://opensearch.eco.tsi-dev.otc-service.com/"

# If extensions (or modules to document with autodoc) are in another directory,
# add these directories to sys.path here. If the directory is relative to the
# documentation root, use os.path.abspath to make it absolute, like shown here.
sys.path.insert(0, os.path.abspath('../../'))
sys.path.insert(0, os.path.abspath('../'))
sys.path.insert(0, os.path.abspath('./'))

# -- General configuration ----------------------------------------------------
# https://docutils.sourceforge.io/docs/user/smartquotes.html - it does not
# what it is expected
smartquotes = False

# Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones.

# The suffix of source filenames.
source_suffix = '.rst'

# The encoding of source files.
#
source_encoding = 'utf-8'

# The master toctree document.
master_doc = 'index'

# General information about the project.
copyright = u'2022-present, Open Telekom Cloud'

# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
#
language = 'en'

# If true, sectionauthor and moduleauthor directives will be shown in the
# output. They are ignored by default.
show_authors = False

# -- Options for HTML output --------------------------------------------------

# The theme to use for HTML and HTML Help pages.  Major themes that come with
# Sphinx are currently 'default' and 'sphinxdoc'.
# html_theme_path = ["."]
html_theme = 'otcdocs'

# Theme options are theme-specific and customize the look and feel of a theme
# further. For a list of options available for each theme, see the
# documentation.
html_theme_options = {
{%- if html_options is defined -%}
{%- for (k, v) in html_options.items() %}
{%- if v is boolean %}
    "{{ k }}": {{ v }},
{%- else %}
    "{{ k }}": "{{ v }}",
{%- endif %}
{%- endfor %}
{%- endif %}
}

# The name for this set of Sphinx documents.  If None, it defaults to
# "<project> v<release> documentation".
{% if title is defined %}
html_title = "{{ title }}"
{% endif %}

# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css".
html_static_path = ['_static']
templates_path = ['_templates']

# Do not include sources into the rendered results
html_copy_source = False

# -- Options for PDF output --------------------------------------------------
latex_documents = [
{%- if doc_type %}
    ('index',
    {%- if doc_type == 'dev' %}
     '{{ service_type }}-dev-guide.tex',
    {%- else %}
     '{{ service_type }}-{{ doc_type }}.tex',
    {% endif -%}
     u'{{ title }}',
     u'OpenTelekomCloud', 'manual'),
{% endif -%}
]

# Get the Git commit values for last updated timestamp on each page
repo = Repo(search_parent_directories=True)
commit = repo.head.commit
current_commit_hash = commit.hexsha
current_commit_time = commit.committed_datetime.strftime('%Y-%m-%d %H:%M')

latex_elements = {
  'papersize': 'a4paper',
  'pointsize': '12pt',
  'figure_align': 'H',
  'preamble': rf'''{% raw %}
        \newcommand{{\githash}}{{{current_commit_hash}}}
        \newcommand{{\gitcommittime}}{{{current_commit_time}}}
        \newcommand{{\doctitle}}{{{otcdocs_doc_title}}}
        \newcommand{{\servicetitle}}{{{otcdocs_service_title}}}{% endraw %}
  ''',
  'sphinxsetup': 'hmargin={15mm,15mm}, vmargin={20mm,30mm}, marginpar=10mm'
}