conf.py

# -*- coding: utf-8 -*-
#
# Configuration file for the Sphinx documentation builder.
#
# This file does only contain a selection of the most common options. For a
# full list see the documentation:
# http://www.sphinx-doc.org/en/master/config

# -- Path setup --------------------------------------------------------------

# 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.
#
# import os
# import sys
# sys.path.insert(0, os.path.abspath('.'))
import datetime as dt
import sphinx_rtd_theme

# -- Project information -----------------------------------------------------

project = 'OXID eShop 7.0'
copyright = '2023 - {}, OXID eSales AG'.format(dt.date.today().year)
author = 'OXID eSales AG'

# The short X.Y version
version = '7.0'
# The full version, including alpha/beta/rc tags
release = '7.0.0'

# -- General configuration ---------------------------------------------------

# If your documentation needs a minimal Sphinx version, state it here.
#
# needs_sphinx = '1.0'

# Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones.
extensions = [
    'sphinx_rtd_theme',
    'sphinx.ext.intersphinx',
    'sphinx.ext.todo',
    'sphinx.ext.ifconfig',
    'sphinx.ext.autosectionlabel',
]

# Make sure the target is unique
autosectionlabel_prefix_document = True

# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']

# The suffix(es) of source filenames.
# You can specify multiple suffix as a list of string:
#
# source_suffix = ['.rst', '.md']
source_suffix = '.rst'

# The master toctree document.
master_doc = 'index'

# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
#
# This is also used if you do content translation via gettext catalogs.
# Usually you set "language" from the command line for these cases.
language = 'de'

# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
# This pattern also affects html_static_path and html_extra_path.
exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']

# The name of the Pygments (syntax highlighting) style to use.
pygments_style = None


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

# The theme to use for HTML and HTML Help pages.  See the documentation for
# a list of builtin themes.
#
html_theme = 'sphinx_rtd_theme'

html_context = {
    'current_version': '7.0',
    'versions': [
         ('6.0', 'https://docs.oxid-esales.com/eshop/de/6.0/'),
         ('6.1', 'https://docs.oxid-esales.com/eshop/de/6.1/'),
         ('6.2', 'https://docs.oxid-esales.com/eshop/de/6.2/'),
         ('6.3', 'https://docs.oxid-esales.com/eshop/de/6.3/'),
         ('6.4', 'https://docs.oxid-esales.com/eshop/de/6.4/'),
         ('6.5', 'https://docs.oxid-esales.com/eshop/de/6.5/'),
         ('7.0', 'https://docs.oxid-esales.com/eshop/de/7.0/'),
         ('7.1', 'https://docs.oxid-esales.com/eshop/de/7.1/'),
     ],
    'languages':
        [('DE', 'https://docs.oxid-esales.com/eshop/de/7.0/'),
         ('EN', 'https://docs.oxid-esales.com/eshop/en/7.0/')],
    'css_files': [('_static/oxid.css')],
    'theme_logo_only': True,
    'show_sphinx': False,
    'display_github': True,
    # Set the following variables to generate the resulting github URL for each page.
    # Format Template: https://{{ github_host|default("github.com") }}/{{ github_user }}/{{ github_repo }}/blob/{{ github_version }}{{ conf_py_path }}{{ pagename }}{{ suffix }}
    'github_user': 'OXID-eSales',
    'github_repo': 'oxideshop-user-documentation',
    'github_version': 'b-7.0-de/'
}

# 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 = {}

# Add any paths that contain custom themes here, relative to this directory.
html_theme_path = ['_themes']

# The name for this set of Sphinx documents.
# "<project> v<release> documentation" by default.
#
html_title = 'OXID eShop 7.0 | Anwenderdokumentation'

# A shorter title for the navigation bar.  Default is the same as html_title.
#
# html_short_title = None

# The name of an image file (relative to this directory) to place at the top
# of the sidebar.
#
html_logo = '_static/logo.png'

# The name of an image file (relative to this directory) to use as a favicon of
# the docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
# pixels large.
#
html_favicon = '_static/favicon.ico'

# 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']

# Custom sidebar templates, must be a dictionary that maps document names
# to template names.
#
# The default sidebars (for documents that don't match any pattern) are
# defined by theme itself.  Builtin themes are using these templates by
# default: ``['localtoc.html', 'relations.html', 'sourcelink.html',
# 'searchbox.html']``.
#
# html_sidebars = {}

# A string of reStructuredText that will be included at the beginning of every source file that is read; custom roles; associated classes are defined in the css
rst_prolog = """
.. role:: db
.. role:: productname
.. role:: technicalname
"""

rst_epilog = """
.. |link| image:: /media/icons/link.png
           :class: no-shadow
.. |procedure| replace:: **Vorgehen**
.. |prerequisites| replace:: **Voraussetzungen**
.. |result| replace:: **Resultat**
.. |background| replace:: **Hintergrund**
.. |example| replace:: **Beispiel**
.. |br| raw:: html

   <br />
"""






# -- Options for HTMLHelp output ---------------------------------------------

# Output file base name for HTML help builder.
htmlhelp_basename = 'OXIDeShop70doc'


# -- Options for LaTeX output ------------------------------------------------

latex_elements = {
    # The paper size ('letterpaper' or 'a4paper').
    #
    # 'papersize': 'letterpaper',

    # The font size ('10pt', '11pt' or '12pt').
    #
    # 'pointsize': '10pt',

    # Additional stuff for the LaTeX preamble.
    #
    # 'preamble': '',

    # Latex figure (float) alignment
    #
    # 'figure_align': 'htbp',
}

# Grouping the document tree into LaTeX files. List of tuples
# (source start file, target name, title,
#  author, documentclass [howto, manual, or own class]).
latex_documents = [
    (master_doc, 'OXIDeShop70.tex', 'OXID eShop 7.0 Anwenderdokumentation',
     'OXID eSales AG', 'manual'),
]


# -- Options for manual page output ------------------------------------------

# One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section).
man_pages = [
    (master_doc, 'oxideshop70', 'OXID eShop 7.0 Anwenderdokumentation',
     [author], 1)
]


# -- Options for Texinfo output ----------------------------------------------

# Grouping the document tree into Texinfo files. List of tuples
# (source start file, target name, title, author,
#  dir menu entry, description, category)
texinfo_documents = [
    (master_doc, 'OXIDeShop70', 'OXID eShop 7.0 Anwenderdokumentation',
     author, 'OXIDeShop70', 'One line description of project.',
     'Miscellaneous'),
]


# -- Options for Epub output -------------------------------------------------

# Bibliographic Dublin Core info.
epub_title = project

# The unique identifier of the text. This can be a ISBN number
# or the project homepage.
#
# epub_identifier = ''

# A unique identification for the text.
#
# epub_uid = ''

# A list of files that should not be packed into the epub file.
epub_exclude_files = ['search.html']


# -- Extension configuration -------------------------------------------------

# -- Options for todo extension ----------------------------------------------

# If true, `todo` and `todoList` produce output, else they produce nothing.
todo_include_todos = False