Read the Docs build information Build id: 631729 Project: quantumcast-public-platform-documentation Version: stable Commit: 483660af57f4eb6d800361afadcc0c260795d166 Date: 2021-05-12T15:42:14.483082Z State: finished Success: False [rtd-command-info] start-time: 2021-05-12T15:42:55.575857Z, end-time: 2021-05-12T15:42:57.065668Z, duration: 1, exit-code: 0 git clone --no-single-branch --depth 50 git@github.com:QuantumCast/platform-documentation.git . Cloning into '.'... Warning: Permanently added 'github.com,192.30.255.113' (RSA) to the list of known hosts. [rtd-command-info] start-time: 2021-05-12T15:42:57.228841Z, end-time: 2021-05-12T15:42:57.314926Z, duration: 0, exit-code: 0 git checkout --force 483660af57f4eb6d800361afadcc0c260795d166 Note: checking out '483660af57f4eb6d800361afadcc0c260795d166'. 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 483660a add Metadata data-set [rtd-command-info] start-time: 2021-05-12T15:42:57.425548Z, end-time: 2021-05-12T15:42:57.494530Z, duration: 0, exit-code: 0 git clean -d -f -f [rtd-command-info] start-time: 2021-05-12T15:42:58.455097Z, end-time: 2021-05-12T15:43:02.724868Z, duration: 4, exit-code: 0 python3.7 -mvirtualenv Using base prefix '/home/docs/.pyenv/versions/3.7.9' New python executable in /home/docs/checkouts/readthedocs.org/user_builds/quantumcast-public-platform-documentation/envs/stable/bin/python3.7 Also creating executable in /home/docs/checkouts/readthedocs.org/user_builds/quantumcast-public-platform-documentation/envs/stable/bin/python Installing setuptools, pip, wheel... done. [rtd-command-info] start-time: 2021-05-12T15:43:02.838989Z, end-time: 2021-05-12T15:43:04.000775Z, duration: 1, exit-code: 0 python -m pip install --upgrade --no-cache-dir pip setuptools Requirement already satisfied: pip in /home/docs/checkouts/readthedocs.org/user_builds/quantumcast-public-platform-documentation/envs/stable/lib/python3.7/site-packages (21.1.1) Requirement already satisfied: setuptools in /home/docs/checkouts/readthedocs.org/user_builds/quantumcast-public-platform-documentation/envs/stable/lib/python3.7/site-packages (56.2.0) [rtd-command-info] start-time: 2021-05-12T15:43:04.109617Z, end-time: 2021-05-12T15:43:13.207191Z, duration: 9, exit-code: 0 python -m pip install --upgrade --no-cache-dir 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 sphinx-rtd-theme readthedocs-sphinx-ext<2.2 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 Downloading Sphinx-4.0.1-py3-none-any.whl (2.9 MB) Collecting sphinx-rtd-theme Downloading sphinx_rtd_theme-0.5.2-py2.py3-none-any.whl (9.1 MB) Collecting readthedocs-sphinx-ext<2.2 Downloading readthedocs_sphinx_ext-2.1.4-py2.py3-none-any.whl (29 kB) Collecting future Downloading future-0.18.2.tar.gz (829 kB) Collecting docutils>=0.11 Downloading docutils-0.17.1-py2.py3-none-any.whl (575 kB) Collecting sphinxcontrib-applehelp Downloading sphinxcontrib_applehelp-1.0.2-py2.py3-none-any.whl (121 kB) Collecting snowballstemmer>=1.1 Downloading snowballstemmer-2.1.0-py2.py3-none-any.whl (93 kB) Collecting sphinxcontrib-jsmath Downloading sphinxcontrib_jsmath-1.0.1-py2.py3-none-any.whl (5.1 kB) Collecting babel>=1.3 Downloading Babel-2.9.1-py2.py3-none-any.whl (8.8 MB) Collecting sphinxcontrib-serializinghtml Downloading sphinxcontrib_serializinghtml-1.1.4-py2.py3-none-any.whl (89 kB) Collecting sphinxcontrib-qthelp Downloading sphinxcontrib_qthelp-1.0.3-py2.py3-none-any.whl (90 kB) Collecting requests>=2.5.0 Downloading requests-2.25.1-py2.py3-none-any.whl (61 kB) Collecting MarkupSafe<2.0 Downloading MarkupSafe-1.1.1-cp37-cp37m-manylinux2010_x86_64.whl (33 kB) Collecting Pygments>=2.0 Downloading Pygments-2.9.0-py3-none-any.whl (1.0 MB) Requirement already satisfied: setuptools in /home/docs/checkouts/readthedocs.org/user_builds/quantumcast-public-platform-documentation/envs/stable/lib/python3.7/site-packages (from sphinx) (56.2.0) Collecting packaging Downloading packaging-20.9-py2.py3-none-any.whl (40 kB) Collecting sphinxcontrib-htmlhelp Downloading sphinxcontrib_htmlhelp-1.0.3-py2.py3-none-any.whl (96 kB) Collecting Jinja2<3.0,>=2.3 Downloading Jinja2-2.11.3-py2.py3-none-any.whl (125 kB) Collecting imagesize Downloading imagesize-1.2.0-py2.py3-none-any.whl (4.8 kB) Collecting sphinxcontrib-devhelp Downloading sphinxcontrib_devhelp-1.0.2-py2.py3-none-any.whl (84 kB) Collecting pytz>=2015.7 Downloading pytz-2021.1-py2.py3-none-any.whl (510 kB) Collecting urllib3<1.27,>=1.21.1 Downloading urllib3-1.26.4-py2.py3-none-any.whl (153 kB) Collecting chardet<5,>=3.0.2 Downloading chardet-4.0.0-py2.py3-none-any.whl (178 kB) Collecting certifi>=2017.4.17 Downloading certifi-2020.12.5-py2.py3-none-any.whl (147 kB) Collecting idna<3,>=2.5 Downloading idna-2.10-py2.py3-none-any.whl (58 kB) Collecting docutils>=0.11 Downloading docutils-0.16-py2.py3-none-any.whl (548 kB) Collecting pyparsing>=2.0.2 Downloading pyparsing-2.4.7-py2.py3-none-any.whl (67 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=23755 sha256=d7636a95aa21f066c1b74eb0df018c7389d2b482221845c4971b9403316b5f30 Stored in directory: /tmp/pip-ephem-wheel-cache-fvvrudju/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=491059 sha256=fd65aa91491c4e60f96ea4a5c8de38b33ec1ed322e8556c27b9c365f9e97906c Stored in directory: /tmp/pip-ephem-wheel-cache-fvvrudju/wheels/56/b0/fe/4410d17b32f1f0c3cf54cdfb2bc04d7b4b8f4ae377e2229ba0 Successfully built mock future Installing collected packages: urllib3, pytz, pyparsing, MarkupSafe, idna, chardet, certifi, sphinxcontrib-serializinghtml, sphinxcontrib-qthelp, sphinxcontrib-jsmath, sphinxcontrib-htmlhelp, sphinxcontrib-devhelp, sphinxcontrib-applehelp, snowballstemmer, requests, Pygments, packaging, Jinja2, imagesize, future, docutils, babel, alabaster, sphinx, commonmark, sphinx-rtd-theme, recommonmark, readthedocs-sphinx-ext, pillow, mock Successfully installed Jinja2-2.11.3 MarkupSafe-1.1.1 Pygments-2.9.0 alabaster-0.7.12 babel-2.9.1 certifi-2020.12.5 chardet-4.0.0 commonmark-0.8.1 docutils-0.16 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-2.1.4 recommonmark-0.5.0 requests-2.25.1 snowballstemmer-2.1.0 sphinx-4.0.1 sphinx-rtd-theme-0.5.2 sphinxcontrib-applehelp-1.0.2 sphinxcontrib-devhelp-1.0.2 sphinxcontrib-htmlhelp-1.0.3 sphinxcontrib-jsmath-1.0.1 sphinxcontrib-qthelp-1.0.3 sphinxcontrib-serializinghtml-1.1.4 urllib3-1.26.4 [rtd-command-info] start-time: 2021-05-12T15:43:13.328535Z, end-time: 2021-05-12T15:43:14.327928Z, duration: 0, exit-code: 0 python -m pip install --exists-action=w --no-cache-dir -r requirements.txt Requirement already satisfied: Sphinx>=3.0 in /home/docs/checkouts/readthedocs.org/user_builds/quantumcast-public-platform-documentation/envs/stable/lib/python3.7/site-packages (from -r requirements.txt (line 1)) (4.0.1) Collecting sphinx-hoverxref>=0.2b1 Downloading sphinx_hoverxref-0.5b1-py3-none-any.whl (34 kB) Collecting sphinx-notfound-page>=0.4 Downloading sphinx_notfound_page-0.6-py3-none-any.whl (13 kB) Requirement already satisfied: sphinx_rtd_theme>=0.4 in /home/docs/checkouts/readthedocs.org/user_builds/quantumcast-public-platform-documentation/envs/stable/lib/python3.7/site-packages (from -r requirements.txt (line 4)) (0.5.2) Requirement already satisfied: sphinxcontrib-serializinghtml in /home/docs/checkouts/readthedocs.org/user_builds/quantumcast-public-platform-documentation/envs/stable/lib/python3.7/site-packages (from Sphinx>=3.0->-r requirements.txt (line 1)) (1.1.4) Requirement already satisfied: alabaster<0.8,>=0.7 in /home/docs/checkouts/readthedocs.org/user_builds/quantumcast-public-platform-documentation/envs/stable/lib/python3.7/site-packages (from Sphinx>=3.0->-r requirements.txt (line 1)) (0.7.12) Requirement already satisfied: MarkupSafe<2.0 in /home/docs/checkouts/readthedocs.org/user_builds/quantumcast-public-platform-documentation/envs/stable/lib/python3.7/site-packages (from Sphinx>=3.0->-r requirements.txt (line 1)) (1.1.1) Requirement already satisfied: snowballstemmer>=1.1 in /home/docs/checkouts/readthedocs.org/user_builds/quantumcast-public-platform-documentation/envs/stable/lib/python3.7/site-packages (from Sphinx>=3.0->-r requirements.txt (line 1)) (2.1.0) Requirement already satisfied: babel>=1.3 in /home/docs/checkouts/readthedocs.org/user_builds/quantumcast-public-platform-documentation/envs/stable/lib/python3.7/site-packages (from Sphinx>=3.0->-r requirements.txt (line 1)) (2.9.1) Requirement already satisfied: setuptools in /home/docs/checkouts/readthedocs.org/user_builds/quantumcast-public-platform-documentation/envs/stable/lib/python3.7/site-packages (from Sphinx>=3.0->-r requirements.txt (line 1)) (56.2.0) Requirement already satisfied: sphinxcontrib-htmlhelp in /home/docs/checkouts/readthedocs.org/user_builds/quantumcast-public-platform-documentation/envs/stable/lib/python3.7/site-packages (from Sphinx>=3.0->-r requirements.txt (line 1)) (1.0.3) Requirement already satisfied: imagesize in /home/docs/checkouts/readthedocs.org/user_builds/quantumcast-public-platform-documentation/envs/stable/lib/python3.7/site-packages (from Sphinx>=3.0->-r requirements.txt (line 1)) (1.2.0) Requirement already satisfied: packaging in /home/docs/checkouts/readthedocs.org/user_builds/quantumcast-public-platform-documentation/envs/stable/lib/python3.7/site-packages (from Sphinx>=3.0->-r requirements.txt (line 1)) (20.9) Requirement already satisfied: docutils<0.18,>=0.14 in /home/docs/checkouts/readthedocs.org/user_builds/quantumcast-public-platform-documentation/envs/stable/lib/python3.7/site-packages (from Sphinx>=3.0->-r requirements.txt (line 1)) (0.16) Requirement already satisfied: sphinxcontrib-devhelp in /home/docs/checkouts/readthedocs.org/user_builds/quantumcast-public-platform-documentation/envs/stable/lib/python3.7/site-packages (from Sphinx>=3.0->-r requirements.txt (line 1)) (1.0.2) Requirement already satisfied: Pygments>=2.0 in /home/docs/checkouts/readthedocs.org/user_builds/quantumcast-public-platform-documentation/envs/stable/lib/python3.7/site-packages (from Sphinx>=3.0->-r requirements.txt (line 1)) (2.9.0) Requirement already satisfied: requests>=2.5.0 in /home/docs/checkouts/readthedocs.org/user_builds/quantumcast-public-platform-documentation/envs/stable/lib/python3.7/site-packages (from Sphinx>=3.0->-r requirements.txt (line 1)) (2.25.1) Requirement already satisfied: sphinxcontrib-jsmath in /home/docs/checkouts/readthedocs.org/user_builds/quantumcast-public-platform-documentation/envs/stable/lib/python3.7/site-packages (from Sphinx>=3.0->-r requirements.txt (line 1)) (1.0.1) Requirement already satisfied: Jinja2<3.0,>=2.3 in /home/docs/checkouts/readthedocs.org/user_builds/quantumcast-public-platform-documentation/envs/stable/lib/python3.7/site-packages (from Sphinx>=3.0->-r requirements.txt (line 1)) (2.11.3) Requirement already satisfied: sphinxcontrib-applehelp in /home/docs/checkouts/readthedocs.org/user_builds/quantumcast-public-platform-documentation/envs/stable/lib/python3.7/site-packages (from Sphinx>=3.0->-r requirements.txt (line 1)) (1.0.2) Requirement already satisfied: sphinxcontrib-qthelp in /home/docs/checkouts/readthedocs.org/user_builds/quantumcast-public-platform-documentation/envs/stable/lib/python3.7/site-packages (from Sphinx>=3.0->-r requirements.txt (line 1)) (1.0.3) Requirement already satisfied: pytz>=2015.7 in /home/docs/checkouts/readthedocs.org/user_builds/quantumcast-public-platform-documentation/envs/stable/lib/python3.7/site-packages (from babel>=1.3->Sphinx>=3.0->-r requirements.txt (line 1)) (2021.1) Requirement already satisfied: chardet<5,>=3.0.2 in /home/docs/checkouts/readthedocs.org/user_builds/quantumcast-public-platform-documentation/envs/stable/lib/python3.7/site-packages (from requests>=2.5.0->Sphinx>=3.0->-r requirements.txt (line 1)) (4.0.0) Requirement already satisfied: urllib3<1.27,>=1.21.1 in /home/docs/checkouts/readthedocs.org/user_builds/quantumcast-public-platform-documentation/envs/stable/lib/python3.7/site-packages (from requests>=2.5.0->Sphinx>=3.0->-r requirements.txt (line 1)) (1.26.4) Requirement already satisfied: idna<3,>=2.5 in /home/docs/checkouts/readthedocs.org/user_builds/quantumcast-public-platform-documentation/envs/stable/lib/python3.7/site-packages (from requests>=2.5.0->Sphinx>=3.0->-r requirements.txt (line 1)) (2.10) Requirement already satisfied: certifi>=2017.4.17 in /home/docs/checkouts/readthedocs.org/user_builds/quantumcast-public-platform-documentation/envs/stable/lib/python3.7/site-packages (from requests>=2.5.0->Sphinx>=3.0->-r requirements.txt (line 1)) (2020.12.5) Requirement already satisfied: pyparsing>=2.0.2 in /home/docs/checkouts/readthedocs.org/user_builds/quantumcast-public-platform-documentation/envs/stable/lib/python3.7/site-packages (from packaging->Sphinx>=3.0->-r requirements.txt (line 1)) (2.4.7) Installing collected packages: sphinx-notfound-page, sphinx-hoverxref Successfully installed sphinx-hoverxref-0.5b1 sphinx-notfound-page-0.6 [rtd-command-info] start-time: 2021-05-12T15:43:15.549619Z, end-time: 2021-05-12T15:43:15.640531Z, duration: 0, exit-code: 0 cat conf.py ## setup -> pip3 install -r requirements.txt # -*- coding: utf-8 -*- # # QuantumCast documentation build configuration file, created by # sphinx-quickstart on Mon Jul 31 15:43:58 2017. # # 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. # 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 sys from datetime import datetime from os import path # -- 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.githubpages'] extensions = [ 'hoverxref.extension', 'notfound.extension', 'sphinx.ext.autodoc', 'sphinx.ext.coverage', 'sphinx.ext.intersphinx', 'sphinx.ext.viewcode', 'sphinx.ext.autosectionlabel' ] 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' # General information about the project. project = u'QuantumCast Platform Documentation' author = u'QuantumCast Team' copyright = '2019-' + str(datetime.now().year) + ', ' + author import re # The full version, including alpha/beta/rc tags. release = re.sub('^v', '', os.popen('git describe').read().strip()) # The short X.Y version. version = release # 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 = u'1.0.0' # The full version, including alpha/beta/rc tags. #release = u'1.0.0' # The short X.Y version. #try: # import docs # version = '.'.join(map(str, docs.version_info[:2])) # release = docs.__version__ #except ImportError: # version = '0.0.1' # release = '0.0.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 = 'en' # 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'] exclude_trees = ['.build'] # The name of the Pygments (syntax highlighting) style to use. pygments_style = 'sphinx' # If true, `todo` and `todoList` produce output, else they produce nothing. todo_include_todos = False # -- 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 = 'alabaster' html_theme = 'sphinx_rtd_theme' #html_theme_path = ["themes"] import sphinx_rtd_theme html_theme_path = [sphinx_rtd_theme.get_html_theme_path()] # 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 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'] html_last_updated_fmt = '%b %d, %Y' html_show_sphinx = True # Custom sidebar templates, must be a dictionary that maps document names # to template names. # # This is required for the alabaster theme # refs: http://alabaster.readthedocs.io/en/latest/installation.html#sidebars #html_sidebars = { # '**': [ # 'about.html', # 'navigation.html', # 'relations.html', # needs 'show_related': True theme option to display # 'searchbox.html', # 'donate.html', # ] #} # -- Options for HTMLHelp output ------------------------------------------ # Output file base name for HTML help builder. htmlhelp_basename = 'QuantumCastDoc' # -- 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, 'quantumcast.tex', u'QuantumCast Platform Documentation', u'QuantumCast', '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, 'quantumcast', u'QuantumCast Platform Documentation', [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, 'quantumcast', u'QuantumCast Platform Documentation', author, 'QuantumCast Team', 'If it isn’t documented, it doesn’t exist.', 'Miscellaneous'), ] # Options for the InterSphinx extension # ------------------------------------- intersphinx_mapping = { 'attrs': ('https://www.attrs.org/en/stable/', None), 'coverage': ('https://coverage.readthedocs.io/en/stable', None), 'cssselect': ('https://cssselect.readthedocs.io/en/latest', None), 'itemloaders': ('https://itemloaders.readthedocs.io/en/latest/', None), 'pytest': ('https://docs.pytest.org/en/latest', None), 'python': ('https://docs.python.org/3', None), 'sphinx': ('https://www.sphinx-doc.org/en/master', None), 'tox': ('https://tox.readthedocs.io/en/latest', None), 'twisted': ('https://twistedmatrix.com/documents/current', None), 'twistedapi': ('https://twistedmatrix.com/documents/current/api', None), 'quantumcast-operation-manual': ('https://docs.quantumcast-digital.com/projects/operation-manual/de/stable/', None), 'quantumcast-cloud-operators': ('https://docs.quantumcast-digital.com/projects/cloud-operators/en/stable/', None), 'quantumcast-platform-documentation': ('https://docs.quantumcast-digital.com/projects/platform/en/stable/', None), 'quantumcast-doc-overview': ('https://docs.quantumcast-digital.com/en/latest/', None), } # Options for sphinx-hoverxref options # Disabled @readthedocs.com with own domain # ------------------------------------ hoverxref_auto_ref = True hoverxref_role_types = { "class": "tooltip", "confval": "tooltip", "hoverxref": "tooltip", "mod": "tooltip", "ref": "tooltip", } hoverxref_roles = ['command', 'reqmeta', 'setting', 'signal'] hoverxref_api_host = 'https://docs.quantumcast-digital.com/_' # https://readthedocs.org ########################################################################### # 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 # # Note: this file should't rely on extra depencies. import importlib import sys import os.path # Borrowed from six. PY3 = sys.version_info[0] == 3 string_types = str if PY3 else basestring 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 = 'https://readthedocs.com/websupport' websupport2_static_url = 'https://assets.readthedocs.com/' #Add project information to the template context. context = { 'using_theme': using_rtd_theme, 'html_theme': html_theme, 'current_version': "stable", 'version_slug': "stable", 'MEDIA_URL': "https://media.readthedocs.com/media/", 'STATIC_URL': "https://assets.readthedocs.com/", 'PRODUCTION_DOMAIN': "readthedocs.com", 'versions': [ ("stable", "/en/stable/"), ], 'downloads': [ ("pdf", "//docs.quantumcast-digital.com/_/downloads/platform/en/stable/pdf/"), ("epub", "//docs.quantumcast-digital.com/_/downloads/platform/en/stable/epub/"), ], 'subprojects': [ ], 'slug': 'quantumcast-public-platform-documentation', 'name': u'Public Platform Documentation', 'rtd_language': u'en', 'programming_language': u'words', 'canonical_url': 'https://docs.quantumcast-digital.com/projects/platform/en/1.0.1/', 'analytics_code': 'None', 'single_version': False, 'conf_py_path': '/', 'api_host': 'https://readthedocs.com', 'github_user': 'QuantumCast', 'proxied_api_host': '/_', 'github_repo': 'platform-documentation', 'github_version': '483660af57f4eb6d800361afadcc0c260795d166', 'display_github': True, 'bitbucket_user': 'None', 'bitbucket_repo': 'None', 'bitbucket_version': '483660af57f4eb6d800361afadcc0c260795d166', 'display_bitbucket': False, 'gitlab_user': 'None', 'gitlab_repo': 'None', 'gitlab_version': '483660af57f4eb6d800361afadcc0c260795d166', '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': 'UA-17997319-2', 'commit': '483660af', } # For sphinx >=1.8 we can use html_baseurl to set the canonical URL. # https://www.sphinx-doc.org/en/master/usage/configuration.html#confval-html_baseurl if version_info >= (1, 8): if not globals().get('html_baseurl'): html_baseurl = context['canonical_url'] context['canonical_url'] = None 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 'tag' == 'external': extensions.insert(1, "readthedocs_ext.external_version_warning") readthedocs_vcs_url = 'None' readthedocs_build_url = 'https://readthedocs.com/projects/quantumcast-public-platform-documentation/builds/631729/' 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-05-12T15:43:15.763466Z, end-time: 2021-05-12T15:43:19.116934Z, duration: 3, exit-code: 1 python -m sphinx -T -W --keep-going -b html -d _build/doctrees -D language=en . _build/html Running Sphinx v4.0.1 loading translations [en]... done making output directory... done loading intersphinx inventory from https://www.attrs.org/en/stable/objects.inv... loading intersphinx inventory from https://coverage.readthedocs.io/en/stable/objects.inv... loading intersphinx inventory from https://cssselect.readthedocs.io/en/latest/objects.inv... loading intersphinx inventory from https://itemloaders.readthedocs.io/en/latest/objects.inv... loading intersphinx inventory from https://docs.pytest.org/en/latest/objects.inv... loading intersphinx inventory from https://docs.python.org/3/objects.inv... loading intersphinx inventory from https://www.sphinx-doc.org/en/master/objects.inv... loading intersphinx inventory from https://tox.readthedocs.io/en/latest/objects.inv... loading intersphinx inventory from https://twistedmatrix.com/documents/current/objects.inv... loading intersphinx inventory from https://twistedmatrix.com/documents/current/api/objects.inv... loading intersphinx inventory from https://docs.quantumcast-digital.com/projects/operation-manual/de/stable/objects.inv... loading intersphinx inventory from https://docs.quantumcast-digital.com/projects/cloud-operators/en/stable/objects.inv... loading intersphinx inventory from https://docs.quantumcast-digital.com/projects/platform/en/stable/objects.inv... loading intersphinx inventory from https://docs.quantumcast-digital.com/en/latest/objects.inv... building [mo]: targets for 0 po files that are out of date building [html]: targets for 40 source files that are out of date updating environment: [new config] 40 added, 0 changed, 0 removed reading sources... [ 2%] developers/metadata reading sources... [ 5%] developers/tcf reading sources... [ 7%] developers/vast4 reading sources... [ 10%] index reading sources... [ 12%] topics/adflow reading sources... [ 15%] topics/advisor reading sources... [ 17%] topics/api reading sources... [ 20%] topics/audiobutler reading sources... [ 22%] topics/audiocache reading sources... [ 25%] topics/audiolibrary reading sources... [ 27%] topics/audioport reading sources... [ 30%] topics/audiostreamer reading sources... [ 32%] topics/audiotools reading sources... [ 35%] topics/authentication reading sources... [ 37%] topics/cloudconnect reading sources... [ 40%] topics/dataanalytics reading sources... [ 42%] topics/dynamicscheduling reading sources... [ 45%] topics/externalschedulingtools reading sources... [ 47%] topics/health reading sources... [ 50%] topics/introduction reading sources... [ 52%] topics/logimporter reading sources... [ 55%] topics/logprocessing reading sources... [ 57%] topics/metaflow reading sources... [ 60%] topics/metaport reading sources... [ 62%] topics/metaspreader reading sources... [ 65%] topics/notificationservice reading sources... [ 67%] topics/playerservices reading sources... [ 70%] topics/playout reading sources... [ 72%] topics/playoutflow reading sources... [ 75%] topics/selfserviceconsole reading sources... [ 77%] topics/sequenceeditor reading sources... [ 80%] topics/skiponradio reading sources... [ 82%] topics/soundprocessing reading sources... [ 85%] topics/spotcontrol reading sources... [ 87%] topics/streamcontrol reading sources... [ 90%] topics/streamrecorder reading sources... [ 92%] topics/streamroute reading sources... [ 95%] topics/streamwatch reading sources... [ 97%] topics/timeshift reading sources... [100%] topics/transcoding WARNING: unknown directive or role name: config:option WARNING: unknown directive or role name: config:option WARNING: unknown directive or role name: config:option WARNING: unknown directive or role name: config:option WARNING: unknown directive or role name: config:option WARNING: unknown directive or role name: config:option WARNING: unknown directive or role name: config:option WARNING: unknown directive or role name: config:option WARNING: unknown directive or role name: config:option WARNING: unknown directive or role name: config:option WARNING: unknown directive or role name: config:option WARNING: unknown directive or role name: config:option WARNING: unknown directive or role name: config:option WARNING: unknown directive or role name: config:option WARNING: unknown directive or role name: config:option WARNING: unknown directive or role name: config:option WARNING: unknown directive or role name: config:option WARNING: unknown directive or role name: config:option WARNING: unknown directive or role name: config:option WARNING: unknown directive or role name: config:option WARNING: unknown directive or role name: config:option WARNING: unknown directive or role name: config:option WARNING: unknown directive or role name: config:option WARNING: unknown directive or role name: config:option WARNING: unknown directive or role name: config:option WARNING: unknown directive or role name: config:option looking for now-outdated files... none found pickling environment... done checking consistency... done preparing documents... done writing output... [ 2%] developers/metadata _hoverxref attributes: {'class': 'reference internal', 'href': '../topics/metaflow.html#metaflow', 'data-project': 'quantumcast-public-platform-documentation', 'data-version': 'stable', 'data-doc': 'topics/metaflow', 'data-docpath': '/topics/metaflow.html', 'data-section': 'metaflow'} _hoverxref attributes: {'class': 'reference internal', 'href': '../topics/metaspreader.html#metaspreader', 'data-project': 'quantumcast-public-platform-documentation', 'data-version': 'stable', 'data-doc': 'topics/metaspreader', 'data-docpath': '/topics/metaspreader.html', 'data-section': 'metaspreader'} writing output... [ 5%] developers/tcf _hoverxref attributes: {'class': 'reference internal', 'href': '../topics/streamroute.html#streamroute', 'data-project': 'quantumcast-public-platform-documentation', 'data-version': 'stable', 'data-doc': 'topics/streamroute', 'data-docpath': '/topics/streamroute.html', 'data-section': 'streamroute'} _hoverxref attributes: {'class': 'reference internal', 'href': '../topics/audiostreamer.html#audiostreamer', 'data-project': 'quantumcast-public-platform-documentation', 'data-version': 'stable', 'data-doc': 'topics/audiostreamer', 'data-docpath': '/topics/audiostreamer.html', 'data-section': 'audiostreamer'} _hoverxref attributes: {'class': 'reference internal', 'href': '../topics/streamroute.html#streamroute', 'data-project': 'quantumcast-public-platform-documentation', 'data-version': 'stable', 'data-doc': 'topics/streamroute', 'data-docpath': '/topics/streamroute.html', 'data-section': 'streamroute'} _hoverxref attributes: {'class': 'reference internal', 'href': '../topics/audiostreamer.html#audiostreamer', 'data-project': 'quantumcast-public-platform-documentation', 'data-version': 'stable', 'data-doc': 'topics/audiostreamer', 'data-docpath': '/topics/audiostreamer.html', 'data-section': 'audiostreamer'} _hoverxref attributes: {'class': 'reference internal', 'href': '../topics/streamroute.html#streamroute', 'data-project': 'quantumcast-public-platform-documentation', 'data-version': 'stable', 'data-doc': 'topics/streamroute', 'data-docpath': '/topics/streamroute.html', 'data-section': 'streamroute'} writing output... [ 7%] developers/vast4 writing output... [ 10%] index Ignoring reference in hoverxref_ignore_refs. target=genindex writing output... [ 12%] topics/adflow writing output... [ 15%] topics/advisor writing output... [ 17%] topics/api writing output... [ 20%] topics/audiobutler writing output... [ 22%] topics/audiocache writing output... [ 25%] topics/audiolibrary writing output... [ 27%] topics/audioport writing output... [ 30%] topics/audiostreamer writing output... [ 32%] topics/audiotools writing output... [ 35%] topics/authentication writing output... [ 37%] topics/cloudconnect writing output... [ 40%] topics/dataanalytics writing output... [ 42%] topics/dynamicscheduling writing output... [ 45%] topics/externalschedulingtools writing output... [ 47%] topics/health writing output... [ 50%] topics/introduction writing output... [ 52%] topics/logimporter writing output... [ 55%] topics/logprocessing writing output... [ 57%] topics/metaflow _hoverxref attributes: {'class': 'reference internal', 'href': 'audioport.html#audioport', 'data-project': 'quantumcast-public-platform-documentation', 'data-version': 'stable', 'data-doc': 'topics/audioport', 'data-docpath': '/topics/audioport.html', 'data-section': 'audioport'} _hoverxref attributes: {'class': 'reference internal', 'href': 'metaport.html#metaport', 'data-project': 'quantumcast-public-platform-documentation', 'data-version': 'stable', 'data-doc': 'topics/metaport', 'data-docpath': '/topics/metaport.html', 'data-section': 'metaport'} _hoverxref attributes: {'class': 'reference internal', 'href': 'playerservices.html#playerservices', 'data-project': 'quantumcast-public-platform-documentation', 'data-version': 'stable', 'data-doc': 'topics/playerservices', 'data-docpath': '/topics/playerservices.html', 'data-section': 'playerservices'} _hoverxref attributes: {'class': 'reference internal', 'href': 'metaport.html#metaport', 'data-project': 'quantumcast-public-platform-documentation', 'data-version': 'stable', 'data-doc': 'topics/metaport', 'data-docpath': '/topics/metaport.html', 'data-section': 'metaport'} _hoverxref attributes: {'class': 'reference internal', 'href': 'metaspreader.html#metaspreader', 'data-project': 'quantumcast-public-platform-documentation', 'data-version': 'stable', 'data-doc': 'topics/metaspreader', 'data-docpath': '/topics/metaspreader.html', 'data-section': 'metaspreader'} writing output... [ 60%] topics/metaport writing output... [ 62%] topics/metaspreader _hoverxref attributes: {'class': 'reference internal', 'href': '../developers/metadata.html#devmetadata', 'data-project': 'quantumcast-public-platform-documentation', 'data-version': 'stable', 'data-doc': 'developers/metadata', 'data-docpath': '/developers/metadata.html', 'data-section': 'devmetadata'} writing output... [ 65%] topics/notificationservice writing output... [ 67%] topics/playerservices writing output... [ 70%] topics/playout writing output... [ 72%] topics/playoutflow writing output... [ 75%] topics/selfserviceconsole writing output... [ 77%] topics/sequenceeditor writing output... [ 80%] topics/skiponradio writing output... [ 82%] topics/soundprocessing writing output... [ 85%] topics/spotcontrol writing output... [ 87%] topics/streamcontrol writing output... [ 90%] topics/streamrecorder writing output... [ 92%] topics/streamroute _hoverxref attributes: {'class': 'reference internal', 'href': '#streamurl-scheme', 'data-project': 'quantumcast-public-platform-documentation', 'data-version': 'stable', 'data-doc': 'topics/streamroute', 'data-docpath': '/topics/streamroute.html', 'data-section': 'streamurl-scheme'} _hoverxref attributes: {'class': 'reference internal', 'href': '../developers/tcf.html#tcfconsent', 'data-project': 'quantumcast-public-platform-documentation', 'data-version': 'stable', 'data-doc': 'developers/tcf', 'data-docpath': '/developers/tcf.html', 'data-section': 'tcfconsent'} _hoverxref attributes: {'class': 'reference internal', 'href': '../developers/vast4.html#vast4integration', 'data-project': 'quantumcast-public-platform-documentation', 'data-version': 'stable', 'data-doc': 'developers/vast4', 'data-docpath': '/developers/vast4.html', 'data-section': 'vast4integration'} writing output... [ 95%] topics/streamwatch writing output... [ 97%] topics/timeshift writing output... [100%] topics/transcoding generating indices... genindex done writing additional pages... search done copying images... [ 33%] topics/img/intro_audiocloudservices.png copying images... [ 66%] topics/img/quantumcast-metaflow.png copying images... [100%] topics/img/intro_dashboard.png copying static files... done copying extra files... done dumping search index in English (code: en)... done dumping object inventory... done build finished with problems, 26 warnings. Updating searchtools for Read the Docs search...