Read the Docs build information Build id: 10763 Project: beckhoff Version: latest Commit: d977d00a5b214786c1ff0186925bbc1beefa5085 Date: 2019-06-13T08:43:54.416006Z State: finished Success: False [rtd-command-info] start-time: 2019-06-13T13:44:02.174000Z, end-time: 2019-06-13T13:44:18.980000Z, duration: 16, exit-code: 0 python -mvirtualenv --no-site-packages --no-download /user_builds/beckhoff/envs/latest New python executable in /user_builds/beckhoff/envs/latest/bin/python Installing setuptools, pip, wheel...done. [rtd-command-info] start-time: 2019-06-13T13:44:19.054000Z, end-time: 2019-06-13T13:45:26.244000Z, duration: 67, exit-code: 0 python /user_builds/beckhoff/envs/latest/bin/pip install --use-wheel -U --cache-dir /user_builds/beckhoff/.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/beckhoff/envs/latest/lib/python2.7/site-packages Requirement already up-to-date: setuptools==20.1.1 in /user_builds/beckhoff/envs/latest/lib/python2.7/site-packages Requirement already up-to-date: docutils==0.12 in /user_builds/beckhoff/envs/latest/lib/python2.7/site-packages Requirement already up-to-date: mkdocs==0.15.0 in /user_builds/beckhoff/envs/latest/lib/python2.7/site-packages Requirement already up-to-date: mock==1.0.1 in /user_builds/beckhoff/envs/latest/lib/python2.7/site-packages Requirement already up-to-date: pillow==2.6.1 in /user_builds/beckhoff/envs/latest/lib/python2.7/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-1kmoSP/readthedocs-sphinx-ext Requirement already up-to-date: sphinx-rtd-theme==0.1.9 in /user_builds/beckhoff/envs/latest/lib/python2.7/site-packages Requirement already up-to-date: alabaster!=0.7.5,<0.8,>=0.7 in /user_builds/beckhoff/envs/latest/lib/python2.7/site-packages Requirement already up-to-date: commonmark==0.5.4 in /user_builds/beckhoff/envs/latest/lib/python2.7/site-packages Requirement already up-to-date: recommonmark==0.1.1 in /user_builds/beckhoff/envs/latest/lib/python2.7/site-packages Requirement already up-to-date: babel!=2.0,>=1.3 in /user_builds/beckhoff/envs/latest/lib/python2.7/site-packages (from sphinx==1.3.5) Requirement already up-to-date: snowballstemmer>=1.1 in /user_builds/beckhoff/envs/latest/lib/python2.7/site-packages (from sphinx==1.3.5) Requirement already up-to-date: six>=1.4 in /user_builds/beckhoff/envs/latest/lib/python2.7/site-packages (from sphinx==1.3.5) Requirement already up-to-date: Jinja2>=2.3 in /user_builds/beckhoff/envs/latest/lib/python2.7/site-packages (from sphinx==1.3.5) Requirement already up-to-date: Markdown>=2.3.1 in /user_builds/beckhoff/envs/latest/lib/python2.7/site-packages (from mkdocs==0.15.0) Requirement already up-to-date: livereload>=2.3.2 in /user_builds/beckhoff/envs/latest/lib/python2.7/site-packages (from mkdocs==0.15.0) Collecting PyYAML>=3.10 (from mkdocs==0.15.0) Downloading https://files.pythonhosted.org/packages/a3/65/837fefac7475963d1eccf4aa684c23b95aa6c1d033a2c5965ccb11e22623/PyYAML-5.1.1.tar.gz (274kB) Requirement already up-to-date: tornado>=4.1 in /user_builds/beckhoff/envs/latest/lib/python2.7/site-packages (from mkdocs==0.15.0) Requirement already up-to-date: click>=4.0 in /user_builds/beckhoff/envs/latest/lib/python2.7/site-packages (from mkdocs==0.15.0) Requirement already up-to-date: mkdocs-bootswatch>=0.1.0 in /user_builds/beckhoff/envs/latest/lib/python2.7/site-packages (from mkdocs==0.15.0) Requirement already up-to-date: mkdocs-bootstrap>=0.1.1 in /user_builds/beckhoff/envs/latest/lib/python2.7/site-packages (from mkdocs==0.15.0) Requirement already up-to-date: requests in /user_builds/beckhoff/envs/latest/lib/python2.7/site-packages (from readthedocs-sphinx-ext) Requirement already up-to-date: nilsimsa>=0.3.7 in /user_builds/beckhoff/envs/latest/lib/python2.7/site-packages (from readthedocs-sphinx-ext) Requirement already up-to-date: pytz>=2015.7 in /user_builds/beckhoff/envs/latest/lib/python2.7/site-packages (from babel!=2.0,>=1.3->sphinx==1.3.5) Requirement already up-to-date: MarkupSafe>=0.23 in /user_builds/beckhoff/envs/latest/lib/python2.7/site-packages (from Jinja2>=2.3->sphinx==1.3.5) Requirement already up-to-date: idna<2.9,>=2.5 in /user_builds/beckhoff/envs/latest/lib/python2.7/site-packages (from requests->readthedocs-sphinx-ext) Requirement already up-to-date: certifi>=2017.4.17 in /user_builds/beckhoff/envs/latest/lib/python2.7/site-packages (from requests->readthedocs-sphinx-ext) Requirement already up-to-date: chardet<3.1.0,>=3.0.2 in /user_builds/beckhoff/envs/latest/lib/python2.7/site-packages (from requests->readthedocs-sphinx-ext) Requirement already up-to-date: urllib3!=1.25.0,!=1.25.1,<1.26,>=1.21.1 in /user_builds/beckhoff/envs/latest/lib/python2.7/site-packages (from requests->readthedocs-sphinx-ext) Building wheels for collected packages: PyYAML Running setup.py bdist_wheel for PyYAML: started Running setup.py bdist_wheel for PyYAML: finished with status 'done' Stored in directory: /user_builds/beckhoff/.cache/pip/wheels/16/27/a1/775c62ddea7bfa62324fd1f65847ed31c55dadb6051481ba3f Successfully built PyYAML Installing collected packages: sphinx, readthedocs-sphinx-ext, PyYAML Found existing installation: Sphinx 2.1.0 Uninstalling Sphinx-2.1.0: Successfully uninstalled Sphinx-2.1.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' Found existing installation: PyYAML 5.1 Uninstalling PyYAML-5.1: Successfully uninstalled PyYAML-5.1 Successfully installed PyYAML-5.1.1 readthedocs-sphinx-ext-0.5.4 sphinx-1.3.5 You are using pip version 8.1.1, however version 19.1.1 is available. You should consider upgrading via the 'pip install --upgrade pip' command. [rtd-command-info] start-time: 2019-06-13T13:45:26.576000Z, end-time: 2019-06-13T13:46:12.478000Z, duration: 45, exit-code: 0 python /user_builds/beckhoff/envs/latest/bin/pip install --exists-action=w --cache-dir /user_builds/beckhoff/.cache/pip -r/user_builds/beckhoff/checkouts/latest/doc/requirements.txt Collecting git+https://xfel.redmine:K9Sss5CmWtQ_nbx3gyt2@git.xfel.eu/gitlab/Karabo/rtd-conf-py.git (from -r /user_builds/beckhoff/checkouts/latest/doc/requirements.txt (line 1)) Cloning https://xfel.redmine:K9Sss5CmWtQ_nbx3gyt2@git.xfel.eu/gitlab/Karabo/rtd-conf-py.git to /tmp/pip-8DSIQM-build Requirement already satisfied (use --upgrade to upgrade): RTDConf==0.1 from git+https://xfel.redmine:K9Sss5CmWtQ_nbx3gyt2@git.xfel.eu/gitlab/Karabo/rtd-conf-py.git in /user_builds/beckhoff/envs/latest/lib/python2.7/site-packages (from -r /user_builds/beckhoff/checkouts/latest/doc/requirements.txt (line 1)) Requirement already satisfied (use --upgrade to upgrade): slumber in /user_builds/beckhoff/envs/latest/lib/python2.7/site-packages (from -r /user_builds/beckhoff/checkouts/latest/doc/requirements.txt (line 2)) Requirement already satisfied (use --upgrade to upgrade): traits in /user_builds/beckhoff/envs/latest/lib/python2.7/site-packages (from -r /user_builds/beckhoff/checkouts/latest/doc/requirements.txt (line 3)) Requirement already satisfied (use --upgrade to upgrade): breathe in /user_builds/beckhoff/envs/latest/lib/python2.7/site-packages (from -r /user_builds/beckhoff/checkouts/latest/doc/requirements.txt (line 4)) Requirement already satisfied (use --upgrade to upgrade): requests in /user_builds/beckhoff/envs/latest/lib/python2.7/site-packages (from slumber->-r /user_builds/beckhoff/checkouts/latest/doc/requirements.txt (line 2)) Requirement already satisfied (use --upgrade to upgrade): docutils>=0.5 in /user_builds/beckhoff/envs/latest/lib/python2.7/site-packages (from breathe->-r /user_builds/beckhoff/checkouts/latest/doc/requirements.txt (line 4)) Collecting Sphinx>=1.4 (from breathe->-r /user_builds/beckhoff/checkouts/latest/doc/requirements.txt (line 4)) Downloading https://files.pythonhosted.org/packages/7c/bc/427495e0564ea7618458e113ecb1c90d48de604652b6eff24a66c9c312cc/Sphinx-2.1.1-py2.py3-none-any.whl (3.2MB) Requirement already satisfied (use --upgrade to upgrade): six>=1.4 in /user_builds/beckhoff/envs/latest/lib/python2.7/site-packages (from breathe->-r /user_builds/beckhoff/checkouts/latest/doc/requirements.txt (line 4)) Requirement already satisfied (use --upgrade to upgrade): idna<2.9,>=2.5 in /user_builds/beckhoff/envs/latest/lib/python2.7/site-packages (from requests->slumber->-r /user_builds/beckhoff/checkouts/latest/doc/requirements.txt (line 2)) Requirement already satisfied (use --upgrade to upgrade): certifi>=2017.4.17 in /user_builds/beckhoff/envs/latest/lib/python2.7/site-packages (from requests->slumber->-r /user_builds/beckhoff/checkouts/latest/doc/requirements.txt (line 2)) Requirement already satisfied (use --upgrade to upgrade): chardet<3.1.0,>=3.0.2 in /user_builds/beckhoff/envs/latest/lib/python2.7/site-packages (from requests->slumber->-r /user_builds/beckhoff/checkouts/latest/doc/requirements.txt (line 2)) Requirement already satisfied (use --upgrade to upgrade): urllib3!=1.25.0,!=1.25.1,<1.26,>=1.21.1 in /user_builds/beckhoff/envs/latest/lib/python2.7/site-packages (from requests->slumber->-r /user_builds/beckhoff/checkouts/latest/doc/requirements.txt (line 2)) Requirement already satisfied (use --upgrade to upgrade): babel!=2.0,>=1.3 in /user_builds/beckhoff/envs/latest/lib/python2.7/site-packages (from Sphinx>=1.4->breathe->-r /user_builds/beckhoff/checkouts/latest/doc/requirements.txt (line 4)) Requirement already satisfied (use --upgrade to upgrade): sphinxcontrib-htmlhelp in /user_builds/beckhoff/envs/latest/lib/python2.7/site-packages (from Sphinx>=1.4->breathe->-r /user_builds/beckhoff/checkouts/latest/doc/requirements.txt (line 4)) Requirement already satisfied (use --upgrade to upgrade): sphinxcontrib-serializinghtml in /user_builds/beckhoff/envs/latest/lib/python2.7/site-packages (from Sphinx>=1.4->breathe->-r /user_builds/beckhoff/checkouts/latest/doc/requirements.txt (line 4)) Requirement already satisfied (use --upgrade to upgrade): sphinxcontrib-applehelp in /user_builds/beckhoff/envs/latest/lib/python2.7/site-packages (from Sphinx>=1.4->breathe->-r /user_builds/beckhoff/checkouts/latest/doc/requirements.txt (line 4)) Requirement already satisfied (use --upgrade to upgrade): imagesize in /user_builds/beckhoff/envs/latest/lib/python2.7/site-packages (from Sphinx>=1.4->breathe->-r /user_builds/beckhoff/checkouts/latest/doc/requirements.txt (line 4)) Requirement already satisfied (use --upgrade to upgrade): sphinxcontrib-qthelp in /user_builds/beckhoff/envs/latest/lib/python2.7/site-packages (from Sphinx>=1.4->breathe->-r /user_builds/beckhoff/checkouts/latest/doc/requirements.txt (line 4)) Requirement already satisfied (use --upgrade to upgrade): setuptools in /user_builds/beckhoff/envs/latest/lib/python2.7/site-packages (from Sphinx>=1.4->breathe->-r /user_builds/beckhoff/checkouts/latest/doc/requirements.txt (line 4)) Requirement already satisfied (use --upgrade to upgrade): packaging in /user_builds/beckhoff/envs/latest/lib/python2.7/site-packages (from Sphinx>=1.4->breathe->-r /user_builds/beckhoff/checkouts/latest/doc/requirements.txt (line 4)) Requirement already satisfied (use --upgrade to upgrade): snowballstemmer>=1.1 in /user_builds/beckhoff/envs/latest/lib/python2.7/site-packages (from Sphinx>=1.4->breathe->-r /user_builds/beckhoff/checkouts/latest/doc/requirements.txt (line 4)) Requirement already satisfied (use --upgrade to upgrade): Pygments>=2.0 in /user_builds/beckhoff/envs/latest/lib/python2.7/site-packages (from Sphinx>=1.4->breathe->-r /user_builds/beckhoff/checkouts/latest/doc/requirements.txt (line 4)) Requirement already satisfied (use --upgrade to upgrade): sphinxcontrib-devhelp in /user_builds/beckhoff/envs/latest/lib/python2.7/site-packages (from Sphinx>=1.4->breathe->-r /user_builds/beckhoff/checkouts/latest/doc/requirements.txt (line 4)) Requirement already satisfied (use --upgrade to upgrade): Jinja2>=2.3 in /user_builds/beckhoff/envs/latest/lib/python2.7/site-packages (from Sphinx>=1.4->breathe->-r /user_builds/beckhoff/checkouts/latest/doc/requirements.txt (line 4)) Requirement already satisfied (use --upgrade to upgrade): sphinxcontrib-jsmath in /user_builds/beckhoff/envs/latest/lib/python2.7/site-packages (from Sphinx>=1.4->breathe->-r /user_builds/beckhoff/checkouts/latest/doc/requirements.txt (line 4)) Requirement already satisfied (use --upgrade to upgrade): alabaster<0.8,>=0.7 in /user_builds/beckhoff/envs/latest/lib/python2.7/site-packages (from Sphinx>=1.4->breathe->-r /user_builds/beckhoff/checkouts/latest/doc/requirements.txt (line 4)) Requirement already satisfied (use --upgrade to upgrade): pytz>=2015.7 in /user_builds/beckhoff/envs/latest/lib/python2.7/site-packages (from babel!=2.0,>=1.3->Sphinx>=1.4->breathe->-r /user_builds/beckhoff/checkouts/latest/doc/requirements.txt (line 4)) Requirement already satisfied (use --upgrade to upgrade): pyparsing>=2.0.2 in /user_builds/beckhoff/envs/latest/lib/python2.7/site-packages (from packaging->Sphinx>=1.4->breathe->-r /user_builds/beckhoff/checkouts/latest/doc/requirements.txt (line 4)) Requirement already satisfied (use --upgrade to upgrade): MarkupSafe>=0.23 in /user_builds/beckhoff/envs/latest/lib/python2.7/site-packages (from Jinja2>=2.3->Sphinx>=1.4->breathe->-r /user_builds/beckhoff/checkouts/latest/doc/requirements.txt (line 4)) Installing collected packages: Sphinx Found existing installation: Sphinx 1.3.5 Uninstalling Sphinx-1.3.5: Successfully uninstalled Sphinx-1.3.5 Successfully installed Sphinx-2.1.1 You are using pip version 8.1.1, however version 19.1.1 is available. You should consider upgrading via the 'pip install --upgrade pip' command. [rtd-command-info] start-time: 2019-06-13T13:46:13.013000Z, end-time: 2019-06-13T13:46:13.044000Z, duration: 0, exit-code: 0 cat conf.py #!/usr/bin/env python3 # -*- coding: utf-8 -*- # # BeckhoffCom documentation build configuration file, created by # sphinx-quickstart on Fri Oct 7 12:32:56 2016. # BeckhoffDevices documentation build configuration file, created by # sphinx-quickstart on Fri Oct 7 13:08:51 2016. # beckhoffSim documentation build configuration file, created by # sphinx-quickstart on Mon Jul 4 18:21:42 2016. # # This file is execfile()d with the current directory set to its # containing dir. # # Note that not all possible configuration values are present in this # autogenerated file. # # All configuration values have a default; values that are commented out # serve to show the default. import sys import os # If extensions (or modules to document with autodoc) are in another directory, # add these directories to sys.path here. If the directory is relative to the # documentation root, use os.path.abspath to make it absolute, like shown here. #sys.path.insert(0, os.path.abspath('.')) # -- General configuration ------------------------------------------------ # If your documentation needs a minimal Sphinx version, state it here. # needs_sphinx = '1.0' numfig = True # Add any Sphinx extension module names here, as strings. They can be # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom # ones. extensions = [ 'sphinx.ext.autodoc', 'sphinx.ext.intersphinx', 'sphinx.ext.todo', 'sphinx.ext.mathjax', 'sphinx.ext.ifconfig', 'sphinx.ext.viewcode', 'sphinx.ext.graphviz', 'sphinx.ext.coverage', ] # Add any paths that contain templates here, relative to this directory. templates_path = ['_templates'] # The suffix of source filenames. source_suffix = '.rst' # The encoding of source files. #source_encoding = 'utf-8-sig' # The master toctree document. master_doc = 'index' # General information about the project. project = 'Beckhoff' copyright = '2016, A. Beckmann and A. Parenti' author = 'A. Beckmann and A. Parenti' # The version info for the project you're documenting, acts as replacement for # |version| and |release|, also used in various other places throughout the # built documents. # # The short X.Y version. version = '3.1' # The full version, including alpha/beta/rc tags. release = '3.1' # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. # # This is also used if you do content translation via gettext catalogs. # Usually you set "language" from the command line for these cases. language = None # There are two options for replacing |today|: either, you set today to some # non-false value, then it is used: # # today = '' # # Else, today_fmt is used as the format for a strftime call. # # today_fmt = '%B %d, %Y' # List of patterns, relative to source directory, that match files and # directories to ignore when looking for source files. # This patterns also effect to html_static_path and html_extra_path exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store'] # The reST default role (used for this markup: `text`) to use for all # documents. # # default_role = None # If true, '()' will be appended to :func: etc. cross-reference text. # # add_function_parentheses = True # If true, the current module name will be prepended to all description # unit titles (such as .. function::). # # add_module_names = True # If true, sectionauthor and moduleauthor directives will be shown in the # output. They are ignored by default. # # show_authors = False # The name of the Pygments (syntax highlighting) style to use. pygments_style = 'sphinx' # A list of ignored prefixes for module index sorting. # modindex_common_prefix = [] # If true, keep warnings as "system message" paragraphs in the built documents. # keep_warnings = False # If true, `todo` and `todoList` produce output, else they produce nothing. todo_include_todos = True # -- Options for HTML output ---------------------------------------------- # The theme to use for HTML and HTML Help pages. See the documentation for # a list of builtin themes. html_theme = 'default' # Theme options are theme-specific and customize the look and feel of a theme # further. For a list of options available for each theme, see the # documentation. # # html_theme_options = {} # Add any paths that contain custom themes here, relative to this directory. # html_theme_path = [] # The name for this set of Sphinx documents. # " v documentation" by default. # # html_title = 'Beckhoff v3.1' # A shorter title for the navigation bar. Default is the same as html_title. # # html_short_title = None # The name of an image file (relative to this directory) to place at the top # of the sidebar. # # html_logo = None # The name of an image file (relative to this directory) to use as a favicon of # the docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 # pixels large. # # html_favicon = None # Add any paths that contain custom static files (such as style sheets) here, # relative to this directory. They are copied after the builtin static files, # so a file named "default.css" will overwrite the builtin "default.css". html_static_path = ['_static'] # Add any extra paths that contain custom files (such as robots.txt or # .htaccess) here, relative to this directory. These files are copied # directly to the root of the documentation. # # html_extra_path = [] # If not None, a 'Last updated on:' timestamp is inserted at every page # bottom, using the given strftime format. # The empty string is equivalent to '%b %d, %Y'. # # html_last_updated_fmt = None # If true, SmartyPants will be used to convert quotes and dashes to # typographically correct entities. # # html_use_smartypants = True # Custom sidebar templates, maps document names to template names. # # html_sidebars = {} # Additional templates that should be rendered to pages, maps page names to # template names. # # html_additional_pages = {} # If false, no module index is generated. # # html_domain_indices = True # If false, no index is generated. # # html_use_index = True # If true, the index is split into individual pages for each letter. # # html_split_index = False # If true, links to the reST sources are added to the pages. # # html_show_sourcelink = True # If true, "Created using Sphinx" is shown in the HTML footer. Default is True. # # html_show_sphinx = True # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. # # html_show_copyright = True # If true, an OpenSearch description file will be output, and all pages will # contain a tag referring to it. The value of this option must be the # base URL from which the finished HTML is served. # # html_use_opensearch = '' # This is the file name suffix for HTML files (e.g. ".xhtml"). # html_file_suffix = None # Language to be used for generating the HTML full-text search index. # Sphinx supports the following languages: # 'da', 'de', 'en', 'es', 'fi', 'fr', 'h', 'it', 'ja' # 'nl', 'no', 'pt', 'ro', 'r', 'sv', 'tr', 'zh' # # html_search_language = 'en' # A dictionary with options for the search language support, empty by default. # 'ja' uses this config value. # 'zh' user can custom change `jieba` dictionary path. # # html_search_options = {'type': 'default'} # The name of a javascript file (relative to the configuration directory) that # implements a search results scorer. If empty, the default will be used. # # html_search_scorer = 'scorer.js' # Output file base name for HTML help builder. htmlhelp_basename = 'Beckhoffdoc' # -- Options for LaTeX output --------------------------------------------- latex_elements = { # The paper size ('letterpaper' or 'a4paper'). # # 'papersize': 'letterpaper', # The font size ('10pt', '11pt' or '12pt'). # # 'pointsize': '10pt', # Additional stuff for the LaTeX preamble. # # 'preamble': '', # Latex figure (float) alignment # # 'figure_align': 'htbp', } # Grouping the document tree into LaTeX files. List of tuples # (source start file, target name, title, # author, documentclass [howto, manual, or own class]). latex_documents = [ (master_doc, 'Beckhoff.tex', 'Beckhoff Documentation', 'A. Beckmann and A. Parenti', 'manual'), ] # The name of an image file (relative to this directory) to place at the top of # the title page. # # latex_logo = None # For "manual" documents, if this is true, then toplevel headings are parts, # not chapters. # # latex_use_parts = False # If true, show page references after internal links. # # latex_show_pagerefs = False # If true, show URL addresses after external links. # # latex_show_urls = False # Documents to append as an appendix to all manuals. # # latex_appendices = [] # It false, will not define \strong, \code, itleref, \crossref ... but only # \sphinxstrong, ..., \sphinxtitleref, ... To help avoid clash with user added # packages. # # latex_keep_old_macro_names = True # If false, no module index is generated. # # latex_domain_indices = True # -- Options for manual page output --------------------------------------- # One entry per manual page. List of tuples # (source start file, name, description, authors, manual section). man_pages = [ (master_doc, 'beckhoff', 'Beckhoff Documentation', [author], 1) ] # If true, show URL addresses after external links. # # man_show_urls = False # -- Options for Texinfo output ------------------------------------------- # Grouping the document tree into Texinfo files. List of tuples # (source start file, target name, title, author, # dir menu entry, description, category) texinfo_documents = [ (master_doc, 'Beckhoff', 'Beckhoff Documentation', author, 'Beckhoff', 'One line description of project.', 'Miscellaneous'), ] # Documents to append as an appendix to all manuals. # # texinfo_appendices = [] # If false, no module index is generated. # # texinfo_domain_indices = True # How to display URL addresses: 'footnote', 'no', or 'inline'. # # texinfo_show_urls = 'footnote' # If true, do not generate a @detailmenu in the "Top" node's menu. # # texinfo_no_detailmenu = False # Example configuration for intersphinx: refer to the Python standard library. intersphinx_mapping = {'https://docs.python.org/': None} #we add a custum function to work with intersphinx import slumber import json # the RTDHOST should be set to localhost if you only compile on RTD # otherwise it needs to be set to the server hosting the internal RTD RTDHOST = 'https://in.xfel.eu/readthedocs' api = slumber.API(base_url='{}/api/v1/'.format(RTDHOST)) projects = api.project.get()['objects'] isphinx = {'python': ('http://python.readthedocs.io/en/latest/', None), 'numpy': ('http://numpy.readthedocs.io/en/latest/', None)} for proj in projects: isphinx[proj['slug'].replace('-', '')] = \ ('{}/docs/{}/en/latest'.format(RTDHOST, proj['slug']), None) intersphinx_mapping = isphinx def setup(app): app.add_config_value('includeDevInfo', 'false', 'env') ########################################################################### # auto-created readthedocs.org specific configuration # ########################################################################### # # The following code was added during an automated build on readthedocs.org # It is auto created and injected for every build. The result is based on the # conf.py.tmpl file found in the readthedocs.org codebase: # https://github.com/rtfd/readthedocs.org/blob/master/readthedocs/doc_builder/templates/doc_builder/conf.py.tmpl # import 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 else: SUFFIX = source_suffix[0] 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') html_static_path.append('/rtd_root/readthedocs/templates/sphinx/_static') # Add RTD Theme only if they aren't overriding it already using_rtd_theme = False if 'html_theme' in globals(): if html_theme in ['default']: # Allow people to bail with a hack of having an html_style if not 'html_style' in globals(): import sphinx_rtd_theme html_theme = 'sphinx_rtd_theme' html_style = None html_theme_options = {} if 'html_theme_path' in globals(): html_theme_path.append(sphinx_rtd_theme.get_html_theme_path()) else: html_theme_path = [sphinx_rtd_theme.get_html_theme_path()] using_rtd_theme = True else: import sphinx_rtd_theme html_theme = 'sphinx_rtd_theme' html_style = None html_theme_options = {} if 'html_theme_path' in globals(): html_theme_path.append(sphinx_rtd_theme.get_html_theme_path()) else: html_theme_path = [sphinx_rtd_theme.get_html_theme_path()] using_rtd_theme = True if globals().get('websupport2_base_url', False): websupport2_base_url = 'https://readthedocs.org/websupport' if 'http' not in settings.MEDIA_URL: websupport2_static_url = '/static/' else: websupport2_static_url = '/media//static' #Add project information to the template context. context = { 'using_theme': using_rtd_theme, 'html_theme': html_theme, 'current_version': "latest", 'MEDIA_URL': "/media/", 'PRODUCTION_DOMAIN': "exflrtd.desy.de", 'versions': [ ("latest", "/en/latest/"), ("stable", "/en/stable/"), ("doc_colums", "/en/doc_colums/"), ], 'downloads': [ ("pdf", "//exflrtd.desy.de/projects/beckhoff/downloads/pdf/latest/"), ("htmlzip", "//exflrtd.desy.de/projects/beckhoff/downloads/htmlzip/latest/"), ("epub", "//exflrtd.desy.de/projects/beckhoff/downloads/epub/latest/"), ], 'subprojects': [ ], 'slug': 'beckhoff', 'name': u'Beckhoff', 'rtd_language': u'en', 'canonical_url': 'http://exflrtd.desy.de/docs/beckhoff/en/latest/', 'analytics_code': 'None', 'single_version': False, 'conf_py_path': '/doc/source/', 'api_host': 'https://readthedocs.org', 'github_user': 'None', 'github_repo': 'None', 'github_version': 'master', 'display_github': False, 'bitbucket_user': 'None', 'bitbucket_repo': 'None', 'bitbucket_version': 'master', 'display_bitbucket': False, 'READTHEDOCS': True, 'using_theme': (html_theme == "default"), 'new_theme': (html_theme == "sphinx_rtd_theme"), 'source_suffix': SUFFIX, 'user_analytics_code': '', 'global_analytics_code': 'UA-17997319-1', 'commit': 'd977d00a', } if 'html_context' in globals(): html_context.update(context) else: html_context = context # Add custom RTD extension if 'extensions' in globals(): extensions.append("readthedocs_ext.readthedocs") else: extensions = ["readthedocs_ext.readthedocs"] [rtd-command-info] start-time: 2019-06-13T13:46:13.216000Z, end-time: 2019-06-13T13:46:13.713000Z, duration: 0, exit-code: 1 python /user_builds/beckhoff/envs/latest/bin/sphinx-build -T -E -b readthedocs -d _build/doctrees-readthedocs -D language=en . _build/html Traceback (most recent call last): File "/user_builds/beckhoff/envs/latest/bin/sphinx-build", line 7, in from sphinx.cmd.build import main File "/user_builds/beckhoff/envs/latest/lib/python2.7/site-packages/sphinx/cmd/build.py", line 39 file=stderr) ^ SyntaxError: invalid syntax