Read the Docs build information
Build id: 26327
Project: beckhoff
Version: latest
Commit: a7ee6395baa479f6635ad9f248dde0eeb794ec94
Date: 2023-06-19T13:48:23.777742Z
State: finished
Success: False


[rtd-command-info] start-time: 2023-06-19T13:48:24.847436Z, end-time: 2023-06-19T13:48:26.212506Z, duration: 1, exit-code: 0
git clone --no-single-branch --depth 50 http://git.xfel.eu/karaboDevices/Beckhoff.git .
Cloning into '.'...

[rtd-command-info] start-time: 2023-06-19T13:48:26.585704Z, end-time: 2023-06-19T13:48:26.711488Z, duration: 0, exit-code: 0
git checkout --force origin/master
Note: checking out 'origin/master'.

You are in 'detached HEAD' state. You can look around, make experimental
changes and commit them, and you can discard any commits you make in this
state without impacting any branches by performing another checkout.

If you want to create a new branch to retain commits you create, you may
do so (now or later) by using -b with the checkout command again. Example:

  git checkout -b <new-branch-name>

HEAD is now at a7ee639 Merge branch 'infigauge_extendedstatebits' into 'master'

[rtd-command-info] start-time: 2023-06-19T13:48:26.797074Z, end-time: 2023-06-19T13:48:26.858377Z, duration: 0, exit-code: 0
git clean -d -f -f


[rtd-command-info] start-time: 2023-06-19T13:48:28.104622Z, end-time: 2023-06-19T13:48:33.231342Z, duration: 5, exit-code: 0
python3.8 -mvirtualenv /usr/src/app/checkouts/readthedocs.org/user_builds/beckhoff/envs/latest
Using base prefix '/home/docs/.pyenv/versions/3.8.0'
New python executable in /usr/src/app/checkouts/readthedocs.org/user_builds/beckhoff/envs/latest/bin/python3.8
Also creating executable in /usr/src/app/checkouts/readthedocs.org/user_builds/beckhoff/envs/latest/bin/python
Installing setuptools, pip, wheel...
done.

[rtd-command-info] start-time: 2023-06-19T13:48:33.322599Z, end-time: 2023-06-19T13:48:34.285610Z, duration: 0, exit-code: 0
/usr/src/app/checkouts/readthedocs.org/user_builds/beckhoff/envs/latest/bin/python -m pip install --upgrade --no-cache-dir pip
Requirement already satisfied: pip in /usr/src/app/checkouts/readthedocs.org/user_builds/beckhoff/envs/latest/lib/python3.8/site-packages (23.1.2)

[rtd-command-info] start-time: 2023-06-19T13:48:34.371733Z, end-time: 2023-06-19T13:48:59.146776Z, duration: 24, exit-code: 0
/usr/src/app/checkouts/readthedocs.org/user_builds/beckhoff/envs/latest/bin/python -m pip install --upgrade --no-cache-dir jinja2==2.11.3 markupsafe==2.0.1 Pygments==2.3.1 setuptools==41.0.1 docutils==0.14 mock==1.0.1 pillow==5.4.1 alabaster>=0.7,<0.8,!=0.7.5 commonmark==0.8.1 recommonmark==0.5.0 sphinx<2 sphinx-rtd-theme<0.5 readthedocs-sphinx-ext<1.1
Collecting jinja2==2.11.3
  Downloading Jinja2-2.11.3-py2.py3-none-any.whl (125 kB)
     ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 125.7/125.7 kB 3.3 MB/s eta 0:00:00
Collecting markupsafe==2.0.1
  Downloading MarkupSafe-2.0.1-cp38-cp38-manylinux_2_5_x86_64.manylinux1_x86_64.manylinux_2_12_x86_64.manylinux2010_x86_64.whl (30 kB)
Collecting Pygments==2.3.1
  Downloading Pygments-2.3.1-py2.py3-none-any.whl (849 kB)
     ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 849.5/849.5 kB 18.3 MB/s eta 0:00:00
Collecting setuptools==41.0.1
  Downloading setuptools-41.0.1-py2.py3-none-any.whl (575 kB)
     ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 576.0/576.0 kB 185.4 MB/s eta 0:00:00
Collecting docutils==0.14
  Downloading docutils-0.14-py3-none-any.whl (543 kB)
     ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 543.2/543.2 kB 206.3 MB/s eta 0:00:00
Collecting mock==1.0.1
  Downloading mock-1.0.1.zip (861 kB)
     ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 861.9/861.9 kB 168.4 MB/s eta 0:00:00
  Preparing metadata (setup.py): started
  Preparing metadata (setup.py): finished with status 'done'
Collecting pillow==5.4.1
  Downloading Pillow-5.4.1.tar.gz (16.0 MB)
     ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 16.0/16.0 MB 140.2 MB/s eta 0:00:00
  Preparing metadata (setup.py): started
  Preparing metadata (setup.py): finished with status 'done'
Collecting alabaster!=0.7.5,<0.8,>=0.7
  Downloading alabaster-0.7.13-py3-none-any.whl (13 kB)
Collecting commonmark==0.8.1
  Downloading commonmark-0.8.1-py2.py3-none-any.whl (47 kB)
     ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 47.4/47.4 kB 109.8 MB/s eta 0:00:00
Collecting recommonmark==0.5.0
  Downloading recommonmark-0.5.0-py2.py3-none-any.whl (9.8 kB)
Collecting sphinx<2
  Downloading Sphinx-1.8.6-py2.py3-none-any.whl (3.1 MB)
     ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 3.1/3.1 MB 158.5 MB/s eta 0:00:00
Collecting sphinx-rtd-theme<0.5
  Downloading sphinx_rtd_theme-0.4.3-py2.py3-none-any.whl (6.4 MB)
     ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 6.4/6.4 MB 157.6 MB/s eta 0:00:00
Collecting readthedocs-sphinx-ext<1.1
  Downloading readthedocs_sphinx_ext-1.0.4-py2.py3-none-any.whl (28 kB)
Collecting future (from commonmark==0.8.1)
  Downloading future-0.18.3.tar.gz (840 kB)
     ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 840.9/840.9 kB 220.4 MB/s eta 0:00:00
  Preparing metadata (setup.py): started
  Preparing metadata (setup.py): finished with status 'done'
Collecting six>=1.5 (from sphinx<2)
  Downloading six-1.16.0-py2.py3-none-any.whl (11 kB)
Collecting snowballstemmer>=1.1 (from sphinx<2)
  Downloading snowballstemmer-2.2.0-py2.py3-none-any.whl (93 kB)
     ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 93.0/93.0 kB 181.8 MB/s eta 0:00:00
Collecting babel!=2.0,>=1.3 (from sphinx<2)
  Downloading Babel-2.12.1-py3-none-any.whl (10.1 MB)
     ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 10.1/10.1 MB 128.2 MB/s eta 0:00:00
Collecting imagesize (from sphinx<2)
  Downloading imagesize-1.4.1-py2.py3-none-any.whl (8.8 kB)
Collecting requests>=2.0.0 (from sphinx<2)
  Downloading requests-2.31.0-py3-none-any.whl (62 kB)
     ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 62.6/62.6 kB 176.8 MB/s eta 0:00:00
Collecting packaging (from sphinx<2)
  Downloading packaging-23.1-py3-none-any.whl (48 kB)
     ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 48.9/48.9 kB 169.8 MB/s eta 0:00:00
Collecting sphinxcontrib-websupport (from sphinx<2)
  Downloading sphinxcontrib_websupport-1.2.4-py2.py3-none-any.whl (39 kB)
Collecting pytz>=2015.7 (from babel!=2.0,>=1.3->sphinx<2)
  Downloading pytz-2023.3-py2.py3-none-any.whl (502 kB)
     ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 502.3/502.3 kB 219.9 MB/s eta 0:00:00
Collecting charset-normalizer<4,>=2 (from requests>=2.0.0->sphinx<2)
  Downloading charset_normalizer-3.1.0-cp38-cp38-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (195 kB)
     ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 195.9/195.9 kB 211.1 MB/s eta 0:00:00
Collecting idna<4,>=2.5 (from requests>=2.0.0->sphinx<2)
  Downloading idna-3.4-py3-none-any.whl (61 kB)
     ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 61.5/61.5 kB 166.4 MB/s eta 0:00:00
Collecting urllib3<3,>=1.21.1 (from requests>=2.0.0->sphinx<2)
  Downloading urllib3-2.0.3-py3-none-any.whl (123 kB)
     ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 123.6/123.6 kB 188.7 MB/s eta 0:00:00
Collecting certifi>=2017.4.17 (from requests>=2.0.0->sphinx<2)
  Downloading certifi-2023.5.7-py3-none-any.whl (156 kB)
     ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 157.0/157.0 kB 199.9 MB/s eta 0:00:00
Collecting sphinxcontrib-serializinghtml (from sphinxcontrib-websupport->sphinx<2)
  Downloading sphinxcontrib_serializinghtml-1.1.5-py2.py3-none-any.whl (94 kB)
     ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 94.0/94.0 kB 184.7 MB/s eta 0:00:00
Building wheels for collected packages: mock, pillow, future
  Building wheel for mock (setup.py): started
  Building wheel for mock (setup.py): finished with status 'done'
  Created wheel for mock: filename=mock-1.0.1-py3-none-any.whl size=23753 sha256=dac9c1041a11c2e791d47fcca1961c9b28b6ba49af366ff848016eb2c6f8f1c9
  Stored in directory: /tmp/pip-ephem-wheel-cache-rcdl2b7m/wheels/41/7c/21/90057f91c6ead7c77a90c52d6e85ca48bf82d8b0d3f8dfbb65
  Building wheel for pillow (setup.py): started
  Building wheel for pillow (setup.py): finished with status 'done'
  Created wheel for pillow: filename=Pillow-5.4.1-cp38-cp38-linux_x86_64.whl size=1262451 sha256=f6a1d20507332ce007ebbecbd8a8ec8068ec806cbcf193fa497e4d9db442f72f
  Stored in directory: /tmp/pip-ephem-wheel-cache-rcdl2b7m/wheels/5f/a8/6b/5b7b3f764d879214eb03570f74d2b086201eb514e6ffa68d6d
  Building wheel for future (setup.py): started
  Building wheel for future (setup.py): finished with status 'done'
  Created wheel for future: filename=future-0.18.3-py3-none-any.whl size=492022 sha256=33322a08a551da86cb64bc1f98bafc99e5c1c1b8a1410a3997144cc2d9de4847
  Stored in directory: /tmp/pip-ephem-wheel-cache-rcdl2b7m/wheels/a0/0b/ee/e6994fadb42c1354dcccb139b0bf2795271bddfe6253ccdf11
Successfully built mock pillow future
Installing collected packages: snowballstemmer, pytz, Pygments, mock, docutils, urllib3, sphinxcontrib-serializinghtml, six, setuptools, pillow, packaging, markupsafe, imagesize, idna, future, charset-normalizer, certifi, babel, alabaster, sphinxcontrib-websupport, requests, jinja2, commonmark, sphinx, readthedocs-sphinx-ext, sphinx-rtd-theme, recommonmark
  Attempting uninstall: setuptools
    Found existing installation: setuptools 67.8.0
    Uninstalling setuptools-67.8.0:
      Successfully uninstalled setuptools-67.8.0
Successfully installed Pygments-2.3.1 alabaster-0.7.13 babel-2.12.1 certifi-2023.5.7 charset-normalizer-3.1.0 commonmark-0.8.1 docutils-0.14 future-0.18.3 idna-3.4 imagesize-1.4.1 jinja2-2.11.3 markupsafe-2.0.1 mock-1.0.1 packaging-23.1 pillow-5.4.1 pytz-2023.3 readthedocs-sphinx-ext-1.0.4 recommonmark-0.5.0 requests-2.31.0 setuptools-41.0.1 six-1.16.0 snowballstemmer-2.2.0 sphinx-1.8.6 sphinx-rtd-theme-0.4.3 sphinxcontrib-serializinghtml-1.1.5 sphinxcontrib-websupport-1.2.4 urllib3-2.0.3

[rtd-command-info] start-time: 2023-06-19T13:48:59.261444Z, end-time: 2023-06-19T13:49:00.835124Z, duration: 1, exit-code: 0
/usr/src/app/checkouts/readthedocs.org/user_builds/beckhoff/envs/latest/bin/python -m pip install --exists-action=w --no-cache-dir -r doc/requirements.txt
Collecting slumber (from -r doc/requirements.txt (line 1))
  Downloading slumber-0.7.1.tar.gz (10 kB)
  Preparing metadata (setup.py): started
  Preparing metadata (setup.py): finished with status 'done'
Requirement already satisfied: requests in /usr/src/app/checkouts/readthedocs.org/user_builds/beckhoff/envs/latest/lib/python3.8/site-packages (from slumber->-r doc/requirements.txt (line 1)) (2.31.0)
Requirement already satisfied: charset-normalizer<4,>=2 in /usr/src/app/checkouts/readthedocs.org/user_builds/beckhoff/envs/latest/lib/python3.8/site-packages (from requests->slumber->-r doc/requirements.txt (line 1)) (3.1.0)
Requirement already satisfied: idna<4,>=2.5 in /usr/src/app/checkouts/readthedocs.org/user_builds/beckhoff/envs/latest/lib/python3.8/site-packages (from requests->slumber->-r doc/requirements.txt (line 1)) (3.4)
Requirement already satisfied: urllib3<3,>=1.21.1 in /usr/src/app/checkouts/readthedocs.org/user_builds/beckhoff/envs/latest/lib/python3.8/site-packages (from requests->slumber->-r doc/requirements.txt (line 1)) (2.0.3)
Requirement already satisfied: certifi>=2017.4.17 in /usr/src/app/checkouts/readthedocs.org/user_builds/beckhoff/envs/latest/lib/python3.8/site-packages (from requests->slumber->-r doc/requirements.txt (line 1)) (2023.5.7)
Building wheels for collected packages: slumber
  Building wheel for slumber (setup.py): started
  Building wheel for slumber (setup.py): finished with status 'done'
  Created wheel for slumber: filename=slumber-0.7.1-py3-none-any.whl size=8098 sha256=e013708580cb65d2464c4aad7174616e18a4cb0113cafeba809210202e5811a5
  Stored in directory: /tmp/pip-ephem-wheel-cache-yjws8sbm/wheels/d9/31/b7/b6202c6ff32847610ed92e1d3cc9d7cf732bcb2d9b5abad083
Successfully built slumber
Installing collected packages: slumber
Successfully installed slumber-0.7.1

[rtd-command-info] start-time: 2023-06-19T13:49:01.567299Z, end-time: 2023-06-19T13:49:01.637932Z, duration: 0, exit-code: 0
cat doc/source/conf.py
#!/usr/bin/env python3
# -*- coding: utf-8 -*-
#
# BeckhoffCom documentation build configuration file, created by
# sphinx-quickstart on Fri Oct  7 12:32:56 2016.
# BeckhoffDevices documentation build configuration file, created by
# sphinx-quickstart on Fri Oct  7 13:08:51 2016.
# beckhoffSim documentation build configuration file, created by
# sphinx-quickstart on Mon Jul  4 18:21:42 2016.
#
# This file is execfile()d with the current directory set to its
# containing dir.
#
# Note that not all possible configuration values are present in this
# autogenerated file.
#
# All configuration values have a default; values that are commented out
# serve to show the default.

import sys
import os

# 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('.'))

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

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

numfig = True

# 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.ext.autodoc',
    'sphinx.ext.intersphinx',
    'sphinx.ext.todo',
    'sphinx.ext.mathjax',
    'sphinx.ext.ifconfig',
    'sphinx.ext.viewcode',
    'sphinx.ext.graphviz',
    'sphinx.ext.coverage',
]

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

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

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

# The master toctree document.
master_doc = 'index'

# General information about the project.
project = 'Beckhoff'
copyright = '2016, A. Beckmann and A. Parenti'
author = 'A. Beckmann and A. Parenti'

# 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 = '3.1'
# The full version, including alpha/beta/rc tags.
release = '3.1'

# 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 = None

# There are two options for replacing |today|: either, you set today to some
# non-false value, then it is used:
#
# today = ''
#
# Else, today_fmt is used as the format for a strftime call.
#
# today_fmt = '%B %d, %Y'

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

# The reST default role (used for this markup: `text`) to use for all
# documents.
#
# default_role = None

# If true, '()' will be appended to :func: etc. cross-reference text.
#
# add_function_parentheses = True

# If true, the current module name will be prepended to all description
# unit titles (such as .. function::).
#
# add_module_names = True

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

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

# A list of ignored prefixes for module index sorting.
# modindex_common_prefix = []

# If true, keep warnings as "system message" paragraphs in the built documents.
# keep_warnings = False

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


# -- 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 = 'default'

# 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 = []

# The name for this set of Sphinx documents.
# "<project> v<release> documentation" by default.
#
# html_title = 'Beckhoff v3.1'

# 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 = None

# 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 = None

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

# Add any extra paths that contain custom files (such as robots.txt or
# .htaccess) here, relative to this directory. These files are copied
# directly to the root of the documentation.
#
# html_extra_path = []

# If not None, a 'Last updated on:' timestamp is inserted at every page
# bottom, using the given strftime format.
# The empty string is equivalent to '%b %d, %Y'.
#
# html_last_updated_fmt = None

# If true, SmartyPants will be used to convert quotes and dashes to
# typographically correct entities.
#
# html_use_smartypants = True

# Custom sidebar templates, maps document names to template names.
#
# html_sidebars = {}

# Additional templates that should be rendered to pages, maps page names to
# template names.
#
# html_additional_pages = {}

# If false, no module index is generated.
#
# html_domain_indices = True

# If false, no index is generated.
#
# html_use_index = True

# If true, the index is split into individual pages for each letter.
#
# html_split_index = False

# If true, links to the reST sources are added to the pages.
#
# html_show_sourcelink = True

# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
#
# html_show_sphinx = True

# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
#
# html_show_copyright = True

# If true, an OpenSearch description file will be output, and all pages will
# contain a <link> tag referring to it.  The value of this option must be the
# base URL from which the finished HTML is served.
#
# html_use_opensearch = ''

# This is the file name suffix for HTML files (e.g. ".xhtml").
# html_file_suffix = None

# Language to be used for generating the HTML full-text search index.
# Sphinx supports the following languages:
#   'da', 'de', 'en', 'es', 'fi', 'fr', 'h', 'it', 'ja'
#   'nl', 'no', 'pt', 'ro', 'r', 'sv', 'tr', 'zh'
#
# html_search_language = 'en'

# A dictionary with options for the search language support, empty by default.
# 'ja' uses this config value.
# 'zh' user can custom change `jieba` dictionary path.
#
# html_search_options = {'type': 'default'}

# The name of a javascript file (relative to the configuration directory) that
# implements a search results scorer. If empty, the default will be used.
#
# html_search_scorer = 'scorer.js'

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

# -- 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, 'Beckhoff.tex', 'Beckhoff Documentation',
     'A. Beckmann and A. Parenti', 'manual'),
]

# The name of an image file (relative to this directory) to place at the top of
# the title page.
#
# latex_logo = None

# For "manual" documents, if this is true, then toplevel headings are parts,
# not chapters.
#
# latex_use_parts = False

# If true, show page references after internal links.
#
# latex_show_pagerefs = False

# If true, show URL addresses after external links.
#
# latex_show_urls = False

# Documents to append as an appendix to all manuals.
#
# latex_appendices = []

# It false, will not define \strong, \code, 	itleref, \crossref ... but only
# \sphinxstrong, ..., \sphinxtitleref, ... To help avoid clash with user added
# packages.
#
# latex_keep_old_macro_names = True

# If false, no module index is generated.
#
# latex_domain_indices = True


# -- 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, 'beckhoff', 'Beckhoff Documentation',
     [author], 1)
]

# If true, show URL addresses after external links.
#
# man_show_urls = False


# -- 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, 'Beckhoff', 'Beckhoff Documentation',
     author, 'Beckhoff', 'One line description of project.',
     'Miscellaneous'),
]

# Documents to append as an appendix to all manuals.
#
# texinfo_appendices = []

# If false, no module index is generated.
#
# texinfo_domain_indices = True

# How to display URL addresses: 'footnote', 'no', or 'inline'.
#
# texinfo_show_urls = 'footnote'

# If true, do not generate a @detailmenu in the "Top" node's menu.
#
# texinfo_no_detailmenu = False

# Example configuration for intersphinx: refer to the Python standard library.
intersphinx_mapping = {'https://docs.python.org/': None}

#we add a custum function to work with intersphinx
import slumber

# the RTDHOST should be set to localhost if you only compile on RTD
# otherwise it needs to be set to the server hosting the internal RTD
RTDHOST = 'https://rtd.xfel.eu/'
api = slumber.API(base_url='{}/api/v2/'.format(RTDHOST))
projects = api.project.get()['results']
isphinx = {'python': ('http://python.readthedocs.io/en/latest/', None),
           'numpy': ('http://numpy.readthedocs.io/en/latest/', None)}

for proj in projects:
    isphinx[proj['slug'].replace('-', '')] = \
     ('{}/docs/{}/en/latest'.format(RTDHOST, proj['slug']), None)


intersphinx_mapping = isphinx

def setup(app):
    app.add_config_value('includeDevInfo', 'false', 'env')




###########################################################################
#          auto-created readthedocs.org specific configuration            #
###########################################################################


#
# The following code was added during an automated build on readthedocs.org
# It is auto created and injected for every build. The result is based on the
# conf.py.tmpl file found in the readthedocs.org codebase:
# https://github.com/rtfd/readthedocs.org/blob/master/readthedocs/doc_builder/templates/doc_builder/conf.py.tmpl
#


import importlib
import sys
import os.path
from six import string_types

from sphinx import version_info

# Get suffix for proper linking to GitHub
# This is deprecated in Sphinx 1.3+,
# as each page can have its own suffix
if globals().get('source_suffix', False):
    if isinstance(source_suffix, string_types):
        SUFFIX = source_suffix
    elif isinstance(source_suffix, (list, tuple)):
        # Sphinx >= 1.3 supports list/tuple to define multiple suffixes
        SUFFIX = source_suffix[0]
    elif isinstance(source_suffix, dict):
        # Sphinx >= 1.8 supports a mapping dictionary for multiple suffixes
        SUFFIX = list(source_suffix.keys())[0]  # make a ``list()`` for py2/py3 compatibility
    else:
        # default to .rst
        SUFFIX = '.rst'
else:
    SUFFIX = '.rst'

# Add RTD Static Path. Add to the end because it overwrites previous files.
if not 'html_static_path' in globals():
    html_static_path = []
if os.path.exists('_static'):
    html_static_path.append('_static')

# Add RTD Theme only if they aren't overriding it already
using_rtd_theme = (
    (
        'html_theme' in globals() and
        html_theme in ['default'] and
        # Allow people to bail with a hack of having an html_style
        'html_style' not in globals()
    ) or 'html_theme' not in globals()
)
if using_rtd_theme:
    theme = importlib.import_module('sphinx_rtd_theme')
    html_theme = 'sphinx_rtd_theme'
    html_style = None
    html_theme_options = {}
    if 'html_theme_path' in globals():
        html_theme_path.append(theme.get_html_theme_path())
    else:
        html_theme_path = [theme.get_html_theme_path()]

if globals().get('websupport2_base_url', False):
    websupport2_base_url = 'http://rtd.xfel.eu/websupport'
    websupport2_static_url = '/static/'


#Add project information to the template context.
context = {
    'using_theme': using_rtd_theme,
    'html_theme': html_theme,
    'current_version': "latest",
    'version_slug': "latest",
    'MEDIA_URL': "media/",
    'STATIC_URL': "/static/",
    'PRODUCTION_DOMAIN': "rtd.xfel.eu",
    'versions': [
    ("latest", "/en/latest/"),
    ],
    'downloads': [ 
    ],
    'subprojects': [ 
    ],
    'slug': 'beckhoff',
    'name': u'Beckhoff',
    'rtd_language': u'en',
    'programming_language': u'words',
    'canonical_url': 'http://rtd.xfel.eu/docs/beckhoff/en/latest/',
    'analytics_code': 'None',
    'single_version': False,
    'conf_py_path': '/doc/source/',
    'api_host': 'http://rtd.xfel.eu',
    'github_user': 'None',
    'proxied_api_host': '/_',
    'github_repo': 'None',
    'github_version': 'master',
    'display_github': False,
    'bitbucket_user': 'None',
    'bitbucket_repo': 'None',
    'bitbucket_version': 'master',
    'display_bitbucket': False,
    'gitlab_user': 'None',
    'gitlab_repo': 'None',
    'gitlab_version': 'master',
    'display_gitlab': False,
    'READTHEDOCS': True,
    'using_theme': (html_theme == "default"),
    'new_theme': (html_theme == "sphinx_rtd_theme"),
    'source_suffix': SUFFIX,
    'ad_free': False,
    'docsearch_disabled': False,
    'user_analytics_code': '',
    'global_analytics_code': 'None',
    'commit': 'a7ee6395',
}




if 'html_context' in globals():
    
    html_context.update(context)
    
else:
    html_context = context

# Add custom RTD extension
if 'extensions' in globals():
    # Insert at the beginning because it can interfere
    # with other extensions.
    # See https://github.com/rtfd/readthedocs.org/pull/4054
    extensions.insert(0, "readthedocs_ext.readthedocs")
else:
    extensions = ["readthedocs_ext.readthedocs"]

# Add External version warning banner to the external version documentation
if 'branch' == 'external':
    extensions.insert(1, "readthedocs_ext.external_version_warning")

project_language = 'en'

# User's Sphinx configurations
language_user = globals().get('language', None)
latex_engine_user = globals().get('latex_engine', None)
latex_elements_user = globals().get('latex_elements', None)

# Remove this once xindy gets installed in Docker image and XINDYOPS
# env variable is supported
# https://github.com/rtfd/readthedocs-docker-images/pull/98
latex_use_xindy = False

chinese = any([
    language_user in ('zh_CN', 'zh_TW'),
    project_language in ('zh_CN', 'zh_TW'),
])

japanese = any([
    language_user == 'ja',
    project_language == 'ja',
])

if chinese:
    latex_engine = latex_engine_user or 'xelatex'

    latex_elements_rtd = {
        'preamble': '\\usepackage[UTF8]{ctex}\n',
    }
    latex_elements = latex_elements_user or latex_elements_rtd
elif japanese:
    latex_engine = latex_engine_user or 'platex'

# Make sure our build directory is always excluded
exclude_patterns = globals().get('exclude_patterns', [])
exclude_patterns.extend(['_build'])

[rtd-command-info] start-time: 2023-06-19T13:49:01.725513Z, end-time: 2023-06-19T13:49:02.074568Z, duration: 0, exit-code: 2
python /usr/src/app/checkouts/readthedocs.org/user_builds/beckhoff/envs/latest/bin/sphinx-build -T -E -b readthedocs -d _build/doctrees-readthedocs -D language=en . _build/html
Running Sphinx v1.8.6

Traceback (most recent call last):
  File "/usr/src/app/checkouts/readthedocs.org/user_builds/beckhoff/envs/latest/lib/python3.8/site-packages/sphinx/config.py", line 368, in eval_config_file
    execfile_(filename, namespace)
  File "/usr/src/app/checkouts/readthedocs.org/user_builds/beckhoff/envs/latest/lib/python3.8/site-packages/sphinx/util/pycompat.py", line 150, in execfile_
    exec_(code, _globals)
  File "/usr/src/app/checkouts/readthedocs.org/user_builds/beckhoff/checkouts/latest/doc/source/conf.py", line 354, in <module>
    import slumber
  File "/usr/src/app/checkouts/readthedocs.org/user_builds/beckhoff/envs/latest/lib/python3.8/site-packages/slumber/__init__.py", line 1, in <module>
    import requests
  File "/usr/src/app/checkouts/readthedocs.org/user_builds/beckhoff/envs/latest/lib/python3.8/site-packages/requests/__init__.py", line 43, in <module>
    import urllib3
  File "/usr/src/app/checkouts/readthedocs.org/user_builds/beckhoff/envs/latest/lib/python3.8/site-packages/urllib3/__init__.py", line 41, in <module>
    raise ImportError(
ImportError: urllib3 v2.0 only supports OpenSSL 1.1.1+, currently the 'ssl' module is compiled with 'OpenSSL 1.0.2n  7 Dec 2017'. See: https://github.com/urllib3/urllib3/issues/2168

During handling of the above exception, another exception occurred:

Traceback (most recent call last):
  File "/usr/src/app/checkouts/readthedocs.org/user_builds/beckhoff/envs/latest/lib/python3.8/site-packages/sphinx/cmd/build.py", line 300, in build_main
    app = Sphinx(args.sourcedir, args.confdir, args.outputdir,
  File "/usr/src/app/checkouts/readthedocs.org/user_builds/beckhoff/envs/latest/lib/python3.8/site-packages/sphinx/application.py", line 201, in __init__
    self.config = Config.read(self.confdir, confoverrides or {}, self.tags)
  File "/usr/src/app/checkouts/readthedocs.org/user_builds/beckhoff/envs/latest/lib/python3.8/site-packages/sphinx/config.py", line 203, in read
    namespace = eval_config_file(filename, tags)
  File "/usr/src/app/checkouts/readthedocs.org/user_builds/beckhoff/envs/latest/lib/python3.8/site-packages/sphinx/config.py", line 380, in eval_config_file
    raise ConfigError(msg % traceback.format_exc())
sphinx.errors.ConfigError: There is a programmable error in your configuration file:

Traceback (most recent call last):
  File "/usr/src/app/checkouts/readthedocs.org/user_builds/beckhoff/envs/latest/lib/python3.8/site-packages/sphinx/config.py", line 368, in eval_config_file
    execfile_(filename, namespace)
  File "/usr/src/app/checkouts/readthedocs.org/user_builds/beckhoff/envs/latest/lib/python3.8/site-packages/sphinx/util/pycompat.py", line 150, in execfile_
    exec_(code, _globals)
  File "/usr/src/app/checkouts/readthedocs.org/user_builds/beckhoff/checkouts/latest/doc/source/conf.py", line 354, in <module>
    import slumber
  File "/usr/src/app/checkouts/readthedocs.org/user_builds/beckhoff/envs/latest/lib/python3.8/site-packages/slumber/__init__.py", line 1, in <module>
    import requests
  File "/usr/src/app/checkouts/readthedocs.org/user_builds/beckhoff/envs/latest/lib/python3.8/site-packages/requests/__init__.py", line 43, in <module>
    import urllib3
  File "/usr/src/app/checkouts/readthedocs.org/user_builds/beckhoff/envs/latest/lib/python3.8/site-packages/urllib3/__init__.py", line 41, in <module>
    raise ImportError(
ImportError: urllib3 v2.0 only supports OpenSSL 1.1.1+, currently the 'ssl' module is compiled with 'OpenSSL 1.0.2n  7 Dec 2017'. See: https://github.com/urllib3/urllib3/issues/2168


Configuration error:
There is a programmable error in your configuration file:

Traceback (most recent call last):
  File "/usr/src/app/checkouts/readthedocs.org/user_builds/beckhoff/envs/latest/lib/python3.8/site-packages/sphinx/config.py", line 368, in eval_config_file
    execfile_(filename, namespace)
  File "/usr/src/app/checkouts/readthedocs.org/user_builds/beckhoff/envs/latest/lib/python3.8/site-packages/sphinx/util/pycompat.py", line 150, in execfile_
    exec_(code, _globals)
  File "/usr/src/app/checkouts/readthedocs.org/user_builds/beckhoff/checkouts/latest/doc/source/conf.py", line 354, in <module>
    import slumber
  File "/usr/src/app/checkouts/readthedocs.org/user_builds/beckhoff/envs/latest/lib/python3.8/site-packages/slumber/__init__.py", line 1, in <module>
    import requests
  File "/usr/src/app/checkouts/readthedocs.org/user_builds/beckhoff/envs/latest/lib/python3.8/site-packages/requests/__init__.py", line 43, in <module>
    import urllib3
  File "/usr/src/app/checkouts/readthedocs.org/user_builds/beckhoff/envs/latest/lib/python3.8/site-packages/urllib3/__init__.py", line 41, in <module>
    raise ImportError(
ImportError: urllib3 v2.0 only supports OpenSSL 1.1.1+, currently the 'ssl' module is compiled with 'OpenSSL 1.0.2n  7 Dec 2017'. See: https://github.com/urllib3/urllib3/issues/2168