Read the Docs build information Build id: 22031 Project: deployed-controls-sa1 Version: latest Commit: 8794c4a33283cd4c6241826bf2a1278bead398d6 Date: 2021-06-30T13:28:14.689590Z State: cloning Success: Unknown [rtd-command-info] start-time: 2021-06-30T13:28:15.771299Z, end-time: 2021-06-30T13:28:20.098932Z, duration: 4, exit-code: 0 git clone --no-single-branch --depth 50 http://git.xfel.eu/gitlab/control-docs/control-docs-sa1.git . Cloning into '.'... [rtd-command-info] start-time: 2021-06-30T13:28:20.457092Z, end-time: 2021-06-30T13:28:20.687214Z, 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 HEAD is now at 8794c4a33 Committing updated structure [rtd-command-info] start-time: 2021-06-30T13:28:20.823258Z, end-time: 2021-06-30T13:28:20.925097Z, duration: 0, exit-code: 0 git clean -d -f -f [rtd-command-info] start-time: 2021-06-30T13:28:21.269359Z, end-time: 2021-06-30T13:28:21.375922Z, duration: 0, exit-code: 0 git submodule sync [rtd-command-info] start-time: 2021-06-30T13:28:21.510263Z, end-time: 2021-06-30T13:28:27.086316Z, duration: 5, exit-code: 0 git submodule update --init --force --recursive control-docs-generic source/userthemes Submodule 'control-docs-generic' (https://haufs:NeSoy5xJnyiLZr2C7M8E@git.xfel.eu/gitlab/control-docs/control-docs-generic.git) registered for path 'control-docs-generic' Submodule 'source/userthemes' (https://haufs:cEMsag5QRLLDwfkFkWkL@git.xfel.eu/gitlab/detectors/rtfd_theme.git) registered for path 'source/userthemes' Cloning into '/usr/src/app/checkouts/readthedocs.org/user_builds/deployed-controls-sa1/checkouts/latest/control-docs-generic'... Cloning into '/usr/src/app/checkouts/readthedocs.org/user_builds/deployed-controls-sa1/checkouts/latest/source/userthemes'... Submodule path 'control-docs-generic': checked out '5a044f1d34e6ff28c8d3777538c641e573fef56c' Submodule path 'source/userthemes': checked out 'fff1622c9b1800b687c03169f3cd42f4aff4e2be' [rtd-command-info] start-time: 2021-06-30T13:28:28.040211Z, end-time: 2021-06-30T13:28:33.429605Z, duration: 5, exit-code: 0 python3.7 -mvirtualenv --system-site-packages /usr/src/app/checkouts/readthedocs.org/user_builds/deployed-controls-sa1/envs/latest Using base prefix '/home/docs/.pyenv/versions/3.7.3' New python executable in /usr/src/app/checkouts/readthedocs.org/user_builds/deployed-controls-sa1/envs/latest/bin/python3.7 Also creating executable in /usr/src/app/checkouts/readthedocs.org/user_builds/deployed-controls-sa1/envs/latest/bin/python Installing setuptools, pip, wheel... done. [rtd-command-info] start-time: 2021-06-30T13:28:33.573554Z, end-time: 2021-06-30T13:28:34.608577Z, duration: 1, exit-code: 0 /usr/src/app/checkouts/readthedocs.org/user_builds/deployed-controls-sa1/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/deployed-controls-sa1/envs/latest/lib/python3.7/site-packages (21.1.3) [rtd-command-info] start-time: 2021-06-30T13:28:34.745017Z, end-time: 2021-06-30T13:28:46.490754Z, duration: 11, exit-code: 0 /usr/src/app/checkouts/readthedocs.org/user_builds/deployed-controls-sa1/envs/latest/bin/python -m pip install --upgrade --no-cache-dir -I 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 Pygments==2.3.1 Downloading Pygments-2.3.1-py2.py3-none-any.whl (849 kB) Collecting setuptools==41.0.1 Downloading setuptools-41.0.1-py2.py3-none-any.whl (575 kB) Collecting docutils==0.14 Downloading docutils-0.14-py3-none-any.whl (543 kB) Collecting mock==1.0.1 Downloading mock-1.0.1.zip (861 kB) Collecting pillow==5.4.1 Downloading Pillow-5.4.1-cp37-cp37m-manylinux1_x86_64.whl (2.0 MB) Collecting alabaster!=0.7.5,<0.8,>=0.7 Downloading alabaster-0.7.12-py2.py3-none-any.whl (14 kB) Collecting commonmark==0.8.1 Downloading commonmark-0.8.1-py2.py3-none-any.whl (47 kB) 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.5-py2.py3-none-any.whl (3.1 MB) Collecting sphinx-rtd-theme<0.5 Downloading sphinx_rtd_theme-0.4.3-py2.py3-none-any.whl (6.4 MB) Collecting readthedocs-sphinx-ext<1.1 Downloading readthedocs_sphinx_ext-1.0.4-py2.py3-none-any.whl (28 kB) Collecting future Downloading future-0.18.2.tar.gz (829 kB) Collecting snowballstemmer>=1.1 Downloading snowballstemmer-2.1.0-py2.py3-none-any.whl (93 kB) Collecting six>=1.5 Downloading six-1.16.0-py2.py3-none-any.whl (11 kB) Collecting babel!=2.0,>=1.3 Downloading Babel-2.9.1-py2.py3-none-any.whl (8.8 MB) Collecting requests>=2.0.0 Downloading requests-2.25.1-py2.py3-none-any.whl (61 kB) Collecting imagesize Downloading imagesize-1.2.0-py2.py3-none-any.whl (4.8 kB) Collecting sphinxcontrib-websupport Downloading sphinxcontrib_websupport-1.2.4-py2.py3-none-any.whl (39 kB) Collecting packaging Downloading packaging-20.9-py2.py3-none-any.whl (40 kB) Collecting Jinja2>=2.3 Downloading Jinja2-3.0.1-py3-none-any.whl (133 kB) Collecting pytz>=2015.7 Downloading pytz-2021.1-py2.py3-none-any.whl (510 kB) Collecting MarkupSafe>=2.0 Downloading MarkupSafe-2.0.1-cp37-cp37m-manylinux2010_x86_64.whl (31 kB) Collecting urllib3<1.27,>=1.21.1 Downloading urllib3-1.26.6-py2.py3-none-any.whl (138 kB) Collecting chardet<5,>=3.0.2 Downloading chardet-4.0.0-py2.py3-none-any.whl (178 kB) Collecting idna<3,>=2.5 Downloading idna-2.10-py2.py3-none-any.whl (58 kB) Collecting certifi>=2017.4.17 Downloading certifi-2021.5.30-py2.py3-none-any.whl (145 kB) Collecting pyparsing>=2.0.2 Downloading pyparsing-2.4.7-py2.py3-none-any.whl (67 kB) Collecting sphinxcontrib-serializinghtml Downloading sphinxcontrib_serializinghtml-1.1.5-py2.py3-none-any.whl (94 kB) Building wheels for collected packages: mock, 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=23772 sha256=37e8200ffc3c83da6cfd1c7847d9b77b787dc5dc31b369a231929f0d776f0388 Stored in directory: /tmp/pip-ephem-wheel-cache-6cq7028i/wheels/7a/94/b1/0fdc5339a5bd487a5cc15421ec200d9ba3e2aa7190e4a727f1 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.2-py3-none-any.whl size=491070 sha256=3a9404d4d28766f3279989b437e70b730b783709e5a39a8ae331e7e25a980a3e Stored in directory: /tmp/pip-ephem-wheel-cache-6cq7028i/wheels/56/b0/fe/4410d17b32f1f0c3cf54cdfb2bc04d7b4b8f4ae377e2229ba0 Successfully built mock future Installing collected packages: urllib3, sphinxcontrib-serializinghtml, pytz, pyparsing, MarkupSafe, idna, chardet, certifi, sphinxcontrib-websupport, snowballstemmer, six, setuptools, requests, Pygments, packaging, Jinja2, imagesize, future, docutils, babel, alabaster, sphinx, commonmark, sphinx-rtd-theme, recommonmark, readthedocs-sphinx-ext, pillow, mock Successfully installed Jinja2-3.0.1 MarkupSafe-2.0.1 Pygments-2.3.1 alabaster-0.7.12 babel-2.9.1 certifi-2021.5.30 chardet-4.0.0 commonmark-0.8.1 docutils-0.14 future-0.18.2 idna-2.10 imagesize-1.2.0 mock-1.0.1 packaging-20.9 pillow-5.4.1 pyparsing-2.4.7 pytz-2021.1 readthedocs-sphinx-ext-1.0.4 recommonmark-0.5.0 requests-2.25.1 setuptools-57.0.0 six-1.16.0 snowballstemmer-2.1.0 sphinx-1.8.5 sphinx-rtd-theme-0.4.3 sphinxcontrib-serializinghtml-1.1.5 sphinxcontrib-websupport-1.2.4 urllib3-1.26.6 [rtd-command-info] start-time: 2021-06-30T13:28:46.625680Z, end-time: 2021-06-30T13:28:51.416563Z, duration: 4, exit-code: 0 /usr/src/app/checkouts/readthedocs.org/user_builds/deployed-controls-sa1/envs/latest/bin/python -m pip install --exists-action=w --no-cache-dir -r source/requirements.txt Collecting git+https://git.xfel.eu/gitlab/xfel-rtd/rtd-conf.git (from -r source/requirements.txt (line 4)) Cloning https://git.xfel.eu/gitlab/xfel-rtd/rtd-conf.git to /tmp/pip-req-build-ilfodulk Running command git clone -q https://git.xfel.eu/gitlab/xfel-rtd/rtd-conf.git /tmp/pip-req-build-ilfodulk Collecting gitpython Downloading GitPython-3.1.18-py3-none-any.whl (170 kB) Requirement already satisfied: sphinx==1.8.5 in /usr/src/app/checkouts/readthedocs.org/user_builds/deployed-controls-sa1/envs/latest/lib/python3.7/site-packages (from -r source/requirements.txt (line 3)) (1.8.5) Collecting slumber Downloading slumber-0.7.1.tar.gz (10 kB) Collecting pyyaml Downloading PyYAML-5.4.1-cp37-cp37m-manylinux1_x86_64.whl (636 kB) Requirement already satisfied: setuptools in /usr/src/app/checkouts/readthedocs.org/user_builds/deployed-controls-sa1/envs/latest/lib/python3.7/site-packages (from sphinx==1.8.5->-r source/requirements.txt (line 3)) (57.0.0) Requirement already satisfied: imagesize in /usr/src/app/checkouts/readthedocs.org/user_builds/deployed-controls-sa1/envs/latest/lib/python3.7/site-packages (from sphinx==1.8.5->-r source/requirements.txt (line 3)) (1.2.0) Requirement already satisfied: babel!=2.0,>=1.3 in /usr/src/app/checkouts/readthedocs.org/user_builds/deployed-controls-sa1/envs/latest/lib/python3.7/site-packages (from sphinx==1.8.5->-r source/requirements.txt (line 3)) (2.9.1) Requirement already satisfied: packaging in /usr/src/app/checkouts/readthedocs.org/user_builds/deployed-controls-sa1/envs/latest/lib/python3.7/site-packages (from sphinx==1.8.5->-r source/requirements.txt (line 3)) (20.9) Requirement already satisfied: sphinxcontrib-websupport in /usr/src/app/checkouts/readthedocs.org/user_builds/deployed-controls-sa1/envs/latest/lib/python3.7/site-packages (from sphinx==1.8.5->-r source/requirements.txt (line 3)) (1.2.4) Requirement already satisfied: alabaster<0.8,>=0.7 in /usr/src/app/checkouts/readthedocs.org/user_builds/deployed-controls-sa1/envs/latest/lib/python3.7/site-packages (from sphinx==1.8.5->-r source/requirements.txt (line 3)) (0.7.12) Requirement already satisfied: snowballstemmer>=1.1 in /usr/src/app/checkouts/readthedocs.org/user_builds/deployed-controls-sa1/envs/latest/lib/python3.7/site-packages (from sphinx==1.8.5->-r source/requirements.txt (line 3)) (2.1.0) Requirement already satisfied: Pygments>=2.0 in /usr/src/app/checkouts/readthedocs.org/user_builds/deployed-controls-sa1/envs/latest/lib/python3.7/site-packages (from sphinx==1.8.5->-r source/requirements.txt (line 3)) (2.3.1) Requirement already satisfied: docutils>=0.11 in /usr/src/app/checkouts/readthedocs.org/user_builds/deployed-controls-sa1/envs/latest/lib/python3.7/site-packages (from sphinx==1.8.5->-r source/requirements.txt (line 3)) (0.14) Requirement already satisfied: requests>=2.0.0 in /usr/src/app/checkouts/readthedocs.org/user_builds/deployed-controls-sa1/envs/latest/lib/python3.7/site-packages (from sphinx==1.8.5->-r source/requirements.txt (line 3)) (2.25.1) Requirement already satisfied: six>=1.5 in /usr/src/app/checkouts/readthedocs.org/user_builds/deployed-controls-sa1/envs/latest/lib/python3.7/site-packages (from sphinx==1.8.5->-r source/requirements.txt (line 3)) (1.16.0) Requirement already satisfied: Jinja2>=2.3 in /usr/src/app/checkouts/readthedocs.org/user_builds/deployed-controls-sa1/envs/latest/lib/python3.7/site-packages (from sphinx==1.8.5->-r source/requirements.txt (line 3)) (3.0.1) Requirement already satisfied: pytz>=2015.7 in /usr/src/app/checkouts/readthedocs.org/user_builds/deployed-controls-sa1/envs/latest/lib/python3.7/site-packages (from babel!=2.0,>=1.3->sphinx==1.8.5->-r source/requirements.txt (line 3)) (2021.1) Requirement already satisfied: MarkupSafe>=2.0 in /usr/src/app/checkouts/readthedocs.org/user_builds/deployed-controls-sa1/envs/latest/lib/python3.7/site-packages (from Jinja2>=2.3->sphinx==1.8.5->-r source/requirements.txt (line 3)) (2.0.1) Requirement already satisfied: chardet<5,>=3.0.2 in /usr/src/app/checkouts/readthedocs.org/user_builds/deployed-controls-sa1/envs/latest/lib/python3.7/site-packages (from requests>=2.0.0->sphinx==1.8.5->-r source/requirements.txt (line 3)) (4.0.0) Requirement already satisfied: idna<3,>=2.5 in /usr/src/app/checkouts/readthedocs.org/user_builds/deployed-controls-sa1/envs/latest/lib/python3.7/site-packages (from requests>=2.0.0->sphinx==1.8.5->-r source/requirements.txt (line 3)) (2.10) Requirement already satisfied: certifi>=2017.4.17 in /usr/src/app/checkouts/readthedocs.org/user_builds/deployed-controls-sa1/envs/latest/lib/python3.7/site-packages (from requests>=2.0.0->sphinx==1.8.5->-r source/requirements.txt (line 3)) (2021.5.30) Requirement already satisfied: urllib3<1.27,>=1.21.1 in /usr/src/app/checkouts/readthedocs.org/user_builds/deployed-controls-sa1/envs/latest/lib/python3.7/site-packages (from requests>=2.0.0->sphinx==1.8.5->-r source/requirements.txt (line 3)) (1.26.6) Collecting gitdb<5,>=4.0.1 Downloading gitdb-4.0.7-py3-none-any.whl (63 kB) Collecting typing-extensions>=3.7.4.0 Downloading typing_extensions-3.10.0.0-py3-none-any.whl (26 kB) Collecting smmap<5,>=3.0.1 Downloading smmap-4.0.0-py2.py3-none-any.whl (24 kB) Requirement already satisfied: pyparsing>=2.0.2 in /usr/src/app/checkouts/readthedocs.org/user_builds/deployed-controls-sa1/envs/latest/lib/python3.7/site-packages (from packaging->sphinx==1.8.5->-r source/requirements.txt (line 3)) (2.4.7) Requirement already satisfied: sphinxcontrib-serializinghtml in /usr/src/app/checkouts/readthedocs.org/user_builds/deployed-controls-sa1/envs/latest/lib/python3.7/site-packages (from sphinxcontrib-websupport->sphinx==1.8.5->-r source/requirements.txt (line 3)) (1.1.5) Building wheels for collected packages: RTDConf, slumber Building wheel for RTDConf (setup.py): started Building wheel for RTDConf (setup.py): finished with status 'done' Created wheel for RTDConf: filename=RTDConf-0.1-py3-none-any.whl size=2649 sha256=954fccb3fca5995844f63c4ab841019962a9592cdd6171af024aae32fe253e47 Stored in directory: /tmp/pip-ephem-wheel-cache-syehzr9p/wheels/17/a3/d4/e42b943fdbccc9aa92ab080ea1739cd6987c6c6d000fb359e4 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=5ef17793c946540c16da452d064fb749ad14059c3f9646411f8971ed5dd62c3e Stored in directory: /tmp/pip-ephem-wheel-cache-syehzr9p/wheels/eb/d6/67/f165e383ef89df4d90f29343f2e120543adc1886663e9f139b Successfully built RTDConf slumber Installing collected packages: smmap, typing-extensions, gitdb, slumber, RTDConf, pyyaml, gitpython Successfully installed RTDConf-0.1 gitdb-4.0.7 gitpython-3.1.18 pyyaml-5.4.1 slumber-0.7.1 smmap-4.0.0 typing-extensions-3.10.0.0 [rtd-command-info] start-time: 2021-06-30T13:28:52.507151Z, end-time: 2021-06-30T13:28:52.590628Z, duration: 0, exit-code: 0 cat source/conf.py # -*- coding: utf-8 -*- # # Deployed Control Systems documentation build configuration file, created by # sphinx-quickstart on Thu Sep 12 12:36:47 2019. # # 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. from rtd_conf.global_conf import intersphinx_mapping import sys, os import subprocess from subprocess import Popen, PIPE import os from datetime import datetime cwd = os.getcwd() # install a fixed theme which support proper math formatting # we need to do this explicitely and not via a requirements.txt as # it needs to go to a specific location depending on this build. os.makedirs("{}/userthemes".format(cwd), exist_ok=True) if os.path.exists("/rtd_root/readthedocs"): os.makedirs("/rtd_root/readthedocs/templates/sphinx/_static", exist_ok=True) # this will update our submodules pcmd = ["git", "submodule", "init"] Popen(pcmd, cwd="..").wait() pcmd = ["git", "submodule", "update", "--recursive", "--remote"] Popen(pcmd, cwd="..").wait() sys.path.append(os.path.abspath('../control-docs-generic/sphinx_ext/')) # This is a bit hacky, but it seems that with submodules file modification # times are sometime corrupted and set to dates in the 1970s. ZIP is not # happy with this an will fail the build. Thus we search for any affected files # here, and then set the mtime to the current time. #pcmd = ["find", "..", "-mtime", "+13700", "-type", "f", "-exec", "touch", # "-d", datetime.now().isoformat(), "{}", "+"] #Popen(pcmd).wait() # If you nevertheless get a ZIP 1980 error, this command will output you # the files which are responsible for triggering it. Should be none if # our fix-up succeeded. #pcmd = ["find", "..", "-mtime", "+13700", "-ls"] #Popen(pcmd).wait() # 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' # 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.doctest', 'sphinx.ext.intersphinx', 'sphinx.ext.todo', 'sphinx.ext.mathjax', 'sphinx.ext.ifconfig', 'include_if_present', 'silent_builder', 'include_from_generic', 'fault_indicators' ] inc_gen_path = os.path.abspath("../control-docs-generic") inc_gen_imap = os.path.abspath("../control-docs-generic/instance_map.yaml") inc_gen_cmap = os.path.abspath("../control-docs-generic/class_map.yaml") mathjax_path="https://in.xfel.eu/readthedocs/media/MathJax-2.7.0/MathJax.js?config=TeX-AMS-MML_HTMLorMML" # noqa # 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 = u'SA1 Control Documentation' copyright = u'2019, Controls Group' # 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 = '0.1' # The full version, including alpha/beta/rc tags. release = '0.1' # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. #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. exclude_patterns = [] # 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 = [] # -- 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_path = ["{}/userthemes".format(cwd)] #html_theme = "sphinx_rtd_theme_patched" # 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. If None, it defaults to # " v documentation". #html_title = None # 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 (within the static path) to use as 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'] # If not '', a 'Last updated on:' timestamp is inserted at every page bottom, # using the given strftime format. #html_last_updated_fmt = '%b %d, %Y' # 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 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 # Output file base name for HTML help builder. # htmlhelp_basename = 'DeployedControlSystemsdoc' # -- 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': '', } # Grouping the document tree into LaTeX files. List of tuples # (source start file, target name, title, author, documentclass [howto/manual]). latex_documents = [ ('index', 'DeployedControlSystems.tex', u'Deployed Control Systems Documentation', u'Controls Group', '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 = [] # 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 = [ ('index', 'deployedcontrolsystems', u'Deployed Control Systems Documentation', [u'Controls Group'], 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 = [ ('index', 'DeployedControlSystems', u'Deployed Control Systems Documentation', u'Controls Group', 'DeployedControlSystems', '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' ########################################################################### # 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': 'deployed-controls-sa1', 'name': u'Deployed Controls - SA1', 'rtd_language': u'en', 'programming_language': u'words', 'canonical_url': 'http://rtd.xfel.eu/docs/deployed-controls-sa1/en/latest/', 'analytics_code': 'None', 'single_version': False, 'conf_py_path': '/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': '8794c4a3', } 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: 2021-06-30T14:28:32.250518Z, end-time: 2021-06-30T14:28:32.333290Z, duration: 0, exit-code: 0 git remote set-url origin https://haufs:zRZASmiye_sEy-Zstrw_@git.xfel.eu/gitlab/control-docs/control-docs-sa1.git