Read the Docs build information Build id: 12574 Project: data-analysis-user-documentation Version: latest Commit: 6ba4a492dc0259b438764be7698857354decb024 Date: 2019-10-02T07:46:33.374556Z State: finished Success: False [rtd-command-info] start-time: 2019-10-02T12:46:59.004000Z, end-time: 2019-10-02T12:47:17.599000Z, duration: 18, exit-code: 0 python3 -mvirtualenv --no-site-packages --no-download /user_builds/data-analysis-user-documentation/envs/latest Using base prefix '/usr' New python executable in /user_builds/data-analysis-user-documentation/envs/latest/bin/python3 Not overwriting existing python script /user_builds/data-analysis-user-documentation/envs/latest/bin/python (you must use /user_builds/data-analysis-user-documentation/envs/latest/bin/python3) Installing setuptools, pip, wheel...done. [rtd-command-info] start-time: 2019-10-02T12:47:17.661000Z, end-time: 2019-10-02T12:48:04.985000Z, duration: 47, exit-code: 0 python /user_builds/data-analysis-user-documentation/envs/latest/bin/pip install --use-wheel -U --cache-dir /user_builds/data-analysis-user-documentation/.cache/pip sphinx==1.3.5 Pygments==2.1.3 setuptools==20.1.1 docutils==0.12 mkdocs==0.15.0 mock==1.0.1 pillow==2.6.1 git+https://github.com/rtfd/readthedocs-sphinx-ext.git@0.6-alpha#egg=readthedocs-sphinx-ext sphinx-rtd-theme==0.1.9 alabaster>=0.7,<0.8,!=0.7.5 commonmark==0.5.4 recommonmark==0.1.1 Collecting sphinx==1.3.5 Using cached https://files.pythonhosted.org/packages/ff/91/45883bc962bda1be7e78039b41cc15e1eb3327ec75679eedd067b5d07bd5/Sphinx-1.3.5-py2.py3-none-any.whl Requirement already up-to-date: Pygments==2.1.3 in /user_builds/data-analysis-user-documentation/envs/latest/lib/python3.4/site-packages Collecting setuptools==20.1.1 Using cached https://files.pythonhosted.org/packages/e8/82/3b5455f74bf9ac0757d09c625b7741e6fc284d7519cffc3babb6c5173cf5/setuptools-20.1.1-py2.py3-none-any.whl Requirement already up-to-date: docutils==0.12 in /user_builds/data-analysis-user-documentation/envs/latest/lib/python3.4/site-packages Requirement already up-to-date: mkdocs==0.15.0 in /user_builds/data-analysis-user-documentation/envs/latest/lib/python3.4/site-packages Requirement already up-to-date: mock==1.0.1 in /user_builds/data-analysis-user-documentation/envs/latest/lib/python3.4/site-packages Requirement already up-to-date: pillow==2.6.1 in /user_builds/data-analysis-user-documentation/envs/latest/lib/python3.4/site-packages Collecting readthedocs-sphinx-ext from git+https://github.com/rtfd/readthedocs-sphinx-ext.git@0.6-alpha#egg=readthedocs-sphinx-ext Cloning https://github.com/rtfd/readthedocs-sphinx-ext.git (to 0.6-alpha) to /tmp/pip-build-p6d8jd5m/readthedocs-sphinx-ext Requirement already up-to-date: sphinx-rtd-theme==0.1.9 in /user_builds/data-analysis-user-documentation/envs/latest/lib/python3.4/site-packages Requirement already up-to-date: alabaster!=0.7.5,<0.8,>=0.7 in /user_builds/data-analysis-user-documentation/envs/latest/lib/python3.4/site-packages Requirement already up-to-date: commonmark==0.5.4 in /user_builds/data-analysis-user-documentation/envs/latest/lib/python3.4/site-packages Requirement already up-to-date: recommonmark==0.1.1 in /user_builds/data-analysis-user-documentation/envs/latest/lib/python3.4/site-packages Requirement already up-to-date: Jinja2>=2.3 in /user_builds/data-analysis-user-documentation/envs/latest/lib/python3.4/site-packages (from sphinx==1.3.5) Requirement already up-to-date: six>=1.4 in /user_builds/data-analysis-user-documentation/envs/latest/lib/python3.4/site-packages (from sphinx==1.3.5) Requirement already up-to-date: babel!=2.0,>=1.3 in /user_builds/data-analysis-user-documentation/envs/latest/lib/python3.4/site-packages (from sphinx==1.3.5) Requirement already up-to-date: snowballstemmer>=1.1 in /user_builds/data-analysis-user-documentation/envs/latest/lib/python3.4/site-packages (from sphinx==1.3.5) Requirement already up-to-date: PyYAML>=3.10 in /user_builds/data-analysis-user-documentation/envs/latest/lib/python3.4/site-packages (from mkdocs==0.15.0) Requirement already up-to-date: Markdown>=2.3.1 in /user_builds/data-analysis-user-documentation/envs/latest/lib/python3.4/site-packages (from mkdocs==0.15.0) Requirement already up-to-date: click>=4.0 in /user_builds/data-analysis-user-documentation/envs/latest/lib/python3.4/site-packages (from mkdocs==0.15.0) Requirement already up-to-date: livereload>=2.3.2 in /user_builds/data-analysis-user-documentation/envs/latest/lib/python3.4/site-packages (from mkdocs==0.15.0) Requirement already up-to-date: mkdocs-bootswatch>=0.1.0 in /user_builds/data-analysis-user-documentation/envs/latest/lib/python3.4/site-packages (from mkdocs==0.15.0) Requirement already up-to-date: tornado>=4.1 in /user_builds/data-analysis-user-documentation/envs/latest/lib/python3.4/site-packages (from mkdocs==0.15.0) Requirement already up-to-date: mkdocs-bootstrap>=0.1.1 in /user_builds/data-analysis-user-documentation/envs/latest/lib/python3.4/site-packages (from mkdocs==0.15.0) Requirement already up-to-date: requests in /user_builds/data-analysis-user-documentation/envs/latest/lib/python3.4/site-packages (from readthedocs-sphinx-ext) Requirement already up-to-date: nilsimsa>=0.3.7 in /user_builds/data-analysis-user-documentation/envs/latest/lib/python3.4/site-packages (from readthedocs-sphinx-ext) Requirement already up-to-date: MarkupSafe>=0.23 in /user_builds/data-analysis-user-documentation/envs/latest/lib/python3.4/site-packages (from Jinja2>=2.3->sphinx==1.3.5) Requirement already up-to-date: pytz>=2015.7 in /user_builds/data-analysis-user-documentation/envs/latest/lib/python3.4/site-packages (from babel!=2.0,>=1.3->sphinx==1.3.5) Requirement already up-to-date: backports-abc>=0.4 in /user_builds/data-analysis-user-documentation/envs/latest/lib/python3.4/site-packages (from tornado>=4.1->mkdocs==0.15.0) Requirement already up-to-date: certifi>=2017.4.17 in /user_builds/data-analysis-user-documentation/envs/latest/lib/python3.4/site-packages (from requests->readthedocs-sphinx-ext) Requirement already up-to-date: urllib3<1.25,>=1.21.1 in /user_builds/data-analysis-user-documentation/envs/latest/lib/python3.4/site-packages (from requests->readthedocs-sphinx-ext) Requirement already up-to-date: idna<2.9,>=2.5 in /user_builds/data-analysis-user-documentation/envs/latest/lib/python3.4/site-packages (from requests->readthedocs-sphinx-ext) Requirement already up-to-date: chardet<3.1.0,>=3.0.2 in /user_builds/data-analysis-user-documentation/envs/latest/lib/python3.4/site-packages (from requests->readthedocs-sphinx-ext) Installing collected packages: sphinx, setuptools, readthedocs-sphinx-ext Found existing installation: Sphinx 1.8.5 Uninstalling Sphinx-1.8.5: Successfully uninstalled Sphinx-1.8.5 Found existing installation: setuptools 28.8.0 Uninstalling setuptools-28.8.0: Successfully uninstalled setuptools-28.8.0 Found existing installation: readthedocs-sphinx-ext 0.5.4 Uninstalling readthedocs-sphinx-ext-0.5.4: Successfully uninstalled readthedocs-sphinx-ext-0.5.4 Running setup.py install for readthedocs-sphinx-ext: started Running setup.py install for readthedocs-sphinx-ext: finished with status 'done' Successfully installed readthedocs-sphinx-ext-0.5.4 setuptools-20.1.1 sphinx-1.3.5 You are using pip version 9.0.1, however version 19.2.3 is available. You should consider upgrading via the 'pip install --upgrade pip' command. [rtd-command-info] start-time: 2019-10-02T12:48:05.050000Z, end-time: 2019-10-02T12:48:41.063000Z, duration: 36, exit-code: 0 python /user_builds/data-analysis-user-documentation/envs/latest/bin/pip install --exists-action=w --cache-dir /user_builds/data-analysis-user-documentation/.cache/pip -rsource/requirements.txt Obtaining karabo_bridge from git+git://github.com/European-XFEL/karabo-bridge-py.git#egg=karabo_bridge (from -r source/requirements.txt (line 1)) Updating /user_builds/data-analysis-user-documentation/envs/latest/src/karabo-bridge clone Requirement already satisfied: nbsphinx in /user_builds/data-analysis-user-documentation/envs/latest/lib/python3.4/site-packages (from -r source/requirements.txt (line 2)) Requirement already satisfied: msgpack>=0.5.4 in /user_builds/data-analysis-user-documentation/envs/latest/lib/python3.4/site-packages (from karabo_bridge->-r source/requirements.txt (line 1)) Requirement already satisfied: msgpack-numpy in /user_builds/data-analysis-user-documentation/envs/latest/lib/python3.4/site-packages (from karabo_bridge->-r source/requirements.txt (line 1)) Requirement already satisfied: numpy in /user_builds/data-analysis-user-documentation/envs/latest/lib/python3.4/site-packages (from karabo_bridge->-r source/requirements.txt (line 1)) Requirement already satisfied: pyzmq>=17.0.0 in /user_builds/data-analysis-user-documentation/envs/latest/lib/python3.4/site-packages (from karabo_bridge->-r source/requirements.txt (line 1)) Requirement already satisfied: docutils in /user_builds/data-analysis-user-documentation/envs/latest/lib/python3.4/site-packages (from nbsphinx->-r source/requirements.txt (line 2)) Requirement already satisfied: nbformat in /user_builds/data-analysis-user-documentation/envs/latest/lib/python3.4/site-packages (from nbsphinx->-r source/requirements.txt (line 2)) Requirement already satisfied: traitlets in /user_builds/data-analysis-user-documentation/envs/latest/lib/python3.4/site-packages (from nbsphinx->-r source/requirements.txt (line 2)) Collecting sphinx>=1.6 (from nbsphinx->-r source/requirements.txt (line 2)) Using cached https://files.pythonhosted.org/packages/7d/66/a4af242b4348b729b9d46ce5db23943ce9bca7da9bbe2ece60dc27f26420/Sphinx-1.8.5-py2.py3-none-any.whl Requirement already satisfied: jinja2 in /user_builds/data-analysis-user-documentation/envs/latest/lib/python3.4/site-packages (from nbsphinx->-r source/requirements.txt (line 2)) Requirement already satisfied: nbconvert!=5.4 in /user_builds/data-analysis-user-documentation/envs/latest/lib/python3.4/site-packages (from nbsphinx->-r source/requirements.txt (line 2)) Requirement already satisfied: jsonschema!=2.5.0,>=2.4 in /user_builds/data-analysis-user-documentation/envs/latest/lib/python3.4/site-packages (from nbformat->nbsphinx->-r source/requirements.txt (line 2)) Requirement already satisfied: jupyter-core in /user_builds/data-analysis-user-documentation/envs/latest/lib/python3.4/site-packages (from nbformat->nbsphinx->-r source/requirements.txt (line 2)) Requirement already satisfied: ipython-genutils in /user_builds/data-analysis-user-documentation/envs/latest/lib/python3.4/site-packages (from nbformat->nbsphinx->-r source/requirements.txt (line 2)) Requirement already satisfied: six in /user_builds/data-analysis-user-documentation/envs/latest/lib/python3.4/site-packages (from traitlets->nbsphinx->-r source/requirements.txt (line 2)) Requirement already satisfied: decorator in /user_builds/data-analysis-user-documentation/envs/latest/lib/python3.4/site-packages (from traitlets->nbsphinx->-r source/requirements.txt (line 2)) Requirement already satisfied: imagesize in /user_builds/data-analysis-user-documentation/envs/latest/lib/python3.4/site-packages (from sphinx>=1.6->nbsphinx->-r source/requirements.txt (line 2)) Requirement already satisfied: setuptools in /user_builds/data-analysis-user-documentation/envs/latest/lib/python3.4/site-packages (from sphinx>=1.6->nbsphinx->-r source/requirements.txt (line 2)) Requirement already satisfied: babel!=2.0,>=1.3 in /user_builds/data-analysis-user-documentation/envs/latest/lib/python3.4/site-packages (from sphinx>=1.6->nbsphinx->-r source/requirements.txt (line 2)) Requirement already satisfied: alabaster<0.8,>=0.7 in /user_builds/data-analysis-user-documentation/envs/latest/lib/python3.4/site-packages (from sphinx>=1.6->nbsphinx->-r source/requirements.txt (line 2)) Requirement already satisfied: Pygments>=2.0 in /user_builds/data-analysis-user-documentation/envs/latest/lib/python3.4/site-packages (from sphinx>=1.6->nbsphinx->-r source/requirements.txt (line 2)) Requirement already satisfied: requests>=2.0.0 in /user_builds/data-analysis-user-documentation/envs/latest/lib/python3.4/site-packages (from sphinx>=1.6->nbsphinx->-r source/requirements.txt (line 2)) Requirement already satisfied: packaging in /user_builds/data-analysis-user-documentation/envs/latest/lib/python3.4/site-packages (from sphinx>=1.6->nbsphinx->-r source/requirements.txt (line 2)) Requirement already satisfied: typing; python_version < "3.5" in /user_builds/data-analysis-user-documentation/envs/latest/lib/python3.4/site-packages (from sphinx>=1.6->nbsphinx->-r source/requirements.txt (line 2)) Requirement already satisfied: sphinxcontrib-websupport in /user_builds/data-analysis-user-documentation/envs/latest/lib/python3.4/site-packages (from sphinx>=1.6->nbsphinx->-r source/requirements.txt (line 2)) Requirement already satisfied: snowballstemmer>=1.1 in /user_builds/data-analysis-user-documentation/envs/latest/lib/python3.4/site-packages (from sphinx>=1.6->nbsphinx->-r source/requirements.txt (line 2)) Requirement already satisfied: MarkupSafe>=0.23 in /user_builds/data-analysis-user-documentation/envs/latest/lib/python3.4/site-packages (from jinja2->nbsphinx->-r source/requirements.txt (line 2)) Requirement already satisfied: bleach in /user_builds/data-analysis-user-documentation/envs/latest/lib/python3.4/site-packages (from nbconvert!=5.4->nbsphinx->-r source/requirements.txt (line 2)) Requirement already satisfied: mistune>=0.8.1 in /user_builds/data-analysis-user-documentation/envs/latest/lib/python3.4/site-packages (from nbconvert!=5.4->nbsphinx->-r source/requirements.txt (line 2)) Requirement already satisfied: defusedxml in /user_builds/data-analysis-user-documentation/envs/latest/lib/python3.4/site-packages (from nbconvert!=5.4->nbsphinx->-r source/requirements.txt (line 2)) Requirement already satisfied: pandocfilters>=1.4.1 in /user_builds/data-analysis-user-documentation/envs/latest/lib/python3.4/site-packages (from nbconvert!=5.4->nbsphinx->-r source/requirements.txt (line 2)) Requirement already satisfied: entrypoints>=0.2.2 in /user_builds/data-analysis-user-documentation/envs/latest/lib/python3.4/site-packages (from nbconvert!=5.4->nbsphinx->-r source/requirements.txt (line 2)) Requirement already satisfied: testpath in /user_builds/data-analysis-user-documentation/envs/latest/lib/python3.4/site-packages (from nbconvert!=5.4->nbsphinx->-r source/requirements.txt (line 2)) Requirement already satisfied: pyrsistent>=0.14.0 in /user_builds/data-analysis-user-documentation/envs/latest/lib/python3.4/site-packages (from jsonschema!=2.5.0,>=2.4->nbformat->nbsphinx->-r source/requirements.txt (line 2)) Requirement already satisfied: attrs>=17.4.0 in /user_builds/data-analysis-user-documentation/envs/latest/lib/python3.4/site-packages (from jsonschema!=2.5.0,>=2.4->nbformat->nbsphinx->-r source/requirements.txt (line 2)) Requirement already satisfied: pytz>=2015.7 in /user_builds/data-analysis-user-documentation/envs/latest/lib/python3.4/site-packages (from babel!=2.0,>=1.3->sphinx>=1.6->nbsphinx->-r source/requirements.txt (line 2)) Requirement already satisfied: idna<2.9,>=2.5 in /user_builds/data-analysis-user-documentation/envs/latest/lib/python3.4/site-packages (from requests>=2.0.0->sphinx>=1.6->nbsphinx->-r source/requirements.txt (line 2)) Requirement already satisfied: certifi>=2017.4.17 in /user_builds/data-analysis-user-documentation/envs/latest/lib/python3.4/site-packages (from requests>=2.0.0->sphinx>=1.6->nbsphinx->-r source/requirements.txt (line 2)) Requirement already satisfied: urllib3<1.25,>=1.21.1 in /user_builds/data-analysis-user-documentation/envs/latest/lib/python3.4/site-packages (from requests>=2.0.0->sphinx>=1.6->nbsphinx->-r source/requirements.txt (line 2)) Requirement already satisfied: chardet<3.1.0,>=3.0.2 in /user_builds/data-analysis-user-documentation/envs/latest/lib/python3.4/site-packages (from requests>=2.0.0->sphinx>=1.6->nbsphinx->-r source/requirements.txt (line 2)) Requirement already satisfied: pyparsing>=2.0.2 in /user_builds/data-analysis-user-documentation/envs/latest/lib/python3.4/site-packages (from packaging->sphinx>=1.6->nbsphinx->-r source/requirements.txt (line 2)) Requirement already satisfied: webencodings in /user_builds/data-analysis-user-documentation/envs/latest/lib/python3.4/site-packages (from bleach->nbconvert!=5.4->nbsphinx->-r source/requirements.txt (line 2)) Installing collected packages: karabo-bridge, sphinx Found existing installation: karabo-bridge 0.3.0 Uninstalling karabo-bridge-0.3.0: Successfully uninstalled karabo-bridge-0.3.0 Running setup.py develop for karabo-bridge Found existing installation: Sphinx 1.3.5 Uninstalling Sphinx-1.3.5: Successfully uninstalled Sphinx-1.3.5 Successfully installed karabo-bridge sphinx-1.8.5 You are using pip version 9.0.1, however version 19.2.3 is available. You should consider upgrading via the 'pip install --upgrade pip' command. [rtd-command-info] start-time: 2019-10-02T12:48:44.911000Z, end-time: 2019-10-02T12:48:44.941000Z, duration: 0, exit-code: 0 cat conf.py #!/usr/bin/env python3 # -*- coding: utf-8 -*- # # User documentation documentation build configuration file, created by # sphinx-quickstart on Mon Jun 26 08:59:34 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('.')) # -- 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.intersphinx', 'sphinx.ext.todo', 'sphinx.ext.autodoc', 'sphinx.ext.napoleon', 'nbsphinx', ] # 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 encoding of source files. # # source_encoding = 'utf-8-sig' # The master toctree document. master_doc = 'index' # General information about the project. project = 'User Documentation' copyright = 'European XFEL' author = 'Hans Fangohr, Sandor Brockhauser and others from CAS and ITDM at XFEL' # 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 = '1.0' # The full version, including alpha/beta/rc tags. release = '1.0' # 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 # If true, figures, tables and code-blocks are automatically numbered if # they have a caption. At same time, the numref role is enabled. For now, # it works only with the HTML builder and LaTeX builder. Default is False. numfig = True on_rtd = os.environ.get('READTHEDOCS') == 'True' if on_rtd: tags.add('readthedocs') # -- 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. # " v documentation" by default. # # html_title = 'Karabo Commissioning Guidelines v1.4.7' # 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 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' # -- Options for HTMLHelp output ------------------------------------------ # Output file base name for HTML help builder. htmlhelp_basename = 'Userdocumentationdoc' # -- 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, 'Userdocumentation.tex', 'User Documentation', 'European XFEL', 'manual'), ] # The name of an image file (relative to this directory) to place at the top of # the title page. # latex_logo = "_templates/european-xfel-logo_cmyk.eps" # 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, 'userdocumentation', 'User documentation 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, 'Userdocumentation', 'User documentation Documentation', author, 'Userdocumentation', '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 have trouble with some of the links in link check # (see https://git.xfel.eu/gitlab/dataAnalysis/user-documentation/issues/2) # -> we ignore the links for which the link check fails on CI linkcheck_ignore = [ 'https://in.xfel.eu/.*', 'https://max-display.desy.de:3443', 'https://confluence.desy.de/display/IS/Docker+containers+on+Maxwell', 'https://confluence.desy.de/display/IS/Alphabetical+List+of+Packages', 'https://www.sigmaaldrich.com/.*', # No idea why this fails on CI , but it does. ] # Limit to 1 minute waiting if a server is stalling linkcheck_timeout = 60 [rtd-command-info] start-time: 2019-10-02T12:48:45.790000Z, end-time: 2019-10-02T12:49:02.352000Z, duration: 16, exit-code: 2 python /user_builds/data-analysis-user-documentation/envs/latest/bin/sphinx-build -T -E -b readthedocs -d _build/doctrees-readthedocs -D language=en . _build/html Running Sphinx v1.8.5 loading translations [en]... done Traceback (most recent call last): File "/user_builds/data-analysis-user-documentation/envs/latest/lib/python3.4/site-packages/sphinx/registry.py", line 146, in preload_builder entry_point = next(entry_points) StopIteration During handling of the above exception, another exception occurred: Traceback (most recent call last): File "/user_builds/data-analysis-user-documentation/envs/latest/lib/python3.4/site-packages/sphinx/cmd/build.py", line 303, in build_main args.tags, args.verbosity, args.jobs, args.keep_going) File "/user_builds/data-analysis-user-documentation/envs/latest/lib/python3.4/site-packages/sphinx/application.py", line 231, in __init__ self.preload_builder(buildername) File "/user_builds/data-analysis-user-documentation/envs/latest/lib/python3.4/site-packages/sphinx/application.py", line 311, in preload_builder self.registry.preload_builder(self, name) File "/user_builds/data-analysis-user-documentation/envs/latest/lib/python3.4/site-packages/sphinx/registry.py", line 149, in preload_builder ' through entry point') % name) sphinx.errors.SphinxError: Builder name readthedocs not registered or available through entry point Sphinx error: Builder name readthedocs not registered or available through entry point