Read the Docs build information Build id: 21353 Project: newsletter Version: latest Commit: f68aa5dd336146c5c33fd4911fe3b94f4dd660c4 Date: 2021-02-08T16:20:50.351571Z State: finished Success: False [rtd-command-info] start-time: 2021-02-08T16:20:51.318943Z, end-time: 2021-02-08T16:20:52.551705Z, duration: 1, exit-code: 0 git clone --no-single-branch --depth 50 http://git.xfel.eu/gitlab/karabo/newsletter.git . Cloning into '.'... [rtd-command-info] start-time: 2021-02-08T16:20:52.939354Z, end-time: 2021-02-08T16:20:53.092350Z, duration: 0, exit-code: 0 git checkout --force origin/master Note: checking out 'origin/master'. You are in 'detached HEAD' state. You can look around, make experimental changes and commit them, and you can discard any commits you make in this state without impacting any branches by performing another checkout. If you want to create a new branch to retain commits you create, you may do so (now or later) by using -b with the checkout command again. Example: git checkout -b HEAD is now at f68aa5d Rtd [rtd-command-info] start-time: 2021-02-08T16:20:53.229964Z, end-time: 2021-02-08T16:20:53.306899Z, duration: 0, exit-code: 0 git clean -d -f -f [rtd-command-info] start-time: 2021-02-08T16:20:54.339673Z, end-time: 2021-02-08T16:20:59.475362Z, duration: 5, exit-code: 0 python3.6 -mvirtualenv /usr/src/app/checkouts/readthedocs.org/user_builds/newsletter/envs/latest Using base prefix '/home/docs/.pyenv/versions/3.6.8' New python executable in /usr/src/app/checkouts/readthedocs.org/user_builds/newsletter/envs/latest/bin/python3.6 Also creating executable in /usr/src/app/checkouts/readthedocs.org/user_builds/newsletter/envs/latest/bin/python Installing setuptools, pip, wheel... done. [rtd-command-info] start-time: 2021-02-08T16:20:59.610558Z, end-time: 2021-02-08T16:21:00.757076Z, duration: 1, exit-code: 0 /usr/src/app/checkouts/readthedocs.org/user_builds/newsletter/envs/latest/bin/python -m pip install --upgrade --no-cache-dir pip Requirement already satisfied: pip in /usr/src/app/checkouts/readthedocs.org/user_builds/newsletter/envs/latest/lib/python3.6/site-packages (21.0.1) [rtd-command-info] start-time: 2021-02-08T16:21:00.879335Z, end-time: 2021-02-08T16:21:14.283029Z, duration: 13, exit-code: 0 /usr/src/app/checkouts/readthedocs.org/user_builds/newsletter/envs/latest/bin/python -m pip install --upgrade --no-cache-dir Pygments==2.3.1 setuptools==41.0.1 docutils==0.14 mock==1.0.1 pillow==5.4.1 alabaster>=0.7,<0.8,!=0.7.5 commonmark==0.8.1 recommonmark==0.5.0 sphinx<2 sphinx-rtd-theme<0.5 readthedocs-sphinx-ext<1.1 Collecting Pygments==2.3.1 Downloading Pygments-2.3.1-py2.py3-none-any.whl (849 kB) Collecting setuptools==41.0.1 Downloading setuptools-41.0.1-py2.py3-none-any.whl (575 kB) Collecting docutils==0.14 Downloading docutils-0.14-py3-none-any.whl (543 kB) Collecting mock==1.0.1 Downloading mock-1.0.1.zip (861 kB) Collecting pillow==5.4.1 Downloading Pillow-5.4.1-cp36-cp36m-manylinux1_x86_64.whl (2.0 MB) Collecting alabaster!=0.7.5,<0.8,>=0.7 Downloading alabaster-0.7.12-py2.py3-none-any.whl (14 kB) Collecting commonmark==0.8.1 Downloading commonmark-0.8.1-py2.py3-none-any.whl (47 kB) Collecting recommonmark==0.5.0 Downloading recommonmark-0.5.0-py2.py3-none-any.whl (9.8 kB) Collecting sphinx<2 Downloading Sphinx-1.8.5-py2.py3-none-any.whl (3.1 MB) Collecting sphinx-rtd-theme<0.5 Downloading sphinx_rtd_theme-0.4.3-py2.py3-none-any.whl (6.4 MB) Collecting readthedocs-sphinx-ext<1.1 Downloading readthedocs_sphinx_ext-1.0.4-py2.py3-none-any.whl (28 kB) Collecting future Downloading future-0.18.2.tar.gz (829 kB) Collecting requests Downloading requests-2.25.1-py2.py3-none-any.whl (61 kB) Collecting Jinja2>=2.9 Downloading Jinja2-2.11.3-py2.py3-none-any.whl (125 kB) Collecting snowballstemmer>=1.1 Downloading snowballstemmer-2.1.0-py2.py3-none-any.whl (93 kB) Collecting packaging Downloading packaging-20.9-py2.py3-none-any.whl (40 kB) Collecting imagesize Downloading imagesize-1.2.0-py2.py3-none-any.whl (4.8 kB) Collecting six>=1.5 Downloading six-1.15.0-py2.py3-none-any.whl (10 kB) Collecting babel!=2.0,>=1.3 Downloading Babel-2.9.0-py2.py3-none-any.whl (8.8 MB) Collecting sphinxcontrib-websupport Downloading sphinxcontrib_websupport-1.2.4-py2.py3-none-any.whl (39 kB) Collecting pytz>=2015.7 Downloading pytz-2021.1-py2.py3-none-any.whl (510 kB) Collecting MarkupSafe>=0.23 Downloading MarkupSafe-1.1.1-cp36-cp36m-manylinux2010_x86_64.whl (32 kB) Collecting certifi>=2017.4.17 Downloading certifi-2020.12.5-py2.py3-none-any.whl (147 kB) Collecting chardet<5,>=3.0.2 Downloading chardet-4.0.0-py2.py3-none-any.whl (178 kB) Collecting urllib3<1.27,>=1.21.1 Downloading urllib3-1.26.3-py2.py3-none-any.whl (137 kB) Collecting idna<3,>=2.5 Downloading idna-2.10-py2.py3-none-any.whl (58 kB) Collecting pyparsing>=2.0.2 Downloading pyparsing-2.4.7-py2.py3-none-any.whl (67 kB) Collecting sphinxcontrib-serializinghtml Downloading sphinxcontrib_serializinghtml-1.1.4-py2.py3-none-any.whl (89 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=500efc14d649706235a08b405d3f8e01f19aab9f12697c816b6b541d8b7a951e Stored in directory: /tmp/pip-ephem-wheel-cache-df_v4ggv/wheels/98/4d/ec/1aa935d28cb63b7b16037fc990302a34244ac3b0601a4e0c00 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=379811c46d701e3f877a1954b5725d95c9f7f60d174165576d5bc4d8d676078f Stored in directory: /tmp/pip-ephem-wheel-cache-df_v4ggv/wheels/6e/9c/ed/4499c9865ac1002697793e0ae05ba6be33553d098f3347fb94 Successfully built mock future Installing collected packages: urllib3, sphinxcontrib-serializinghtml, pytz, pyparsing, MarkupSafe, idna, chardet, certifi, sphinxcontrib-websupport, snowballstemmer, six, setuptools, requests, Pygments, packaging, Jinja2, imagesize, future, docutils, babel, alabaster, sphinx, commonmark, sphinx-rtd-theme, recommonmark, readthedocs-sphinx-ext, pillow, mock Attempting uninstall: setuptools Found existing installation: setuptools 53.0.0 Uninstalling setuptools-53.0.0: Successfully uninstalled setuptools-53.0.0 Successfully installed Jinja2-2.11.3 MarkupSafe-1.1.1 Pygments-2.3.1 alabaster-0.7.12 babel-2.9.0 certifi-2020.12.5 chardet-4.0.0 commonmark-0.8.1 docutils-0.14 future-0.18.2 idna-2.10 imagesize-1.2.0 mock-1.0.1 packaging-20.9 pillow-5.4.1 pyparsing-2.4.7 pytz-2021.1 readthedocs-sphinx-ext-1.0.4 recommonmark-0.5.0 requests-2.25.1 setuptools-41.0.1 six-1.15.0 snowballstemmer-2.1.0 sphinx-1.8.5 sphinx-rtd-theme-0.4.3 sphinxcontrib-serializinghtml-1.1.4 sphinxcontrib-websupport-1.2.4 urllib3-1.26.3 [rtd-command-info] start-time: 2021-02-08T16:21:14.412585Z, end-time: 2021-02-08T16:21:24.986156Z, duration: 10, exit-code: 0 /usr/src/app/checkouts/readthedocs.org/user_builds/newsletter/envs/latest/bin/python -m pip install --exists-action=w --no-cache-dir -r source/requirements.txt Collecting git+https://git.xfel.eu/gitlab/xfel-rtd/rtd-conf.git (from -r source/requirements.txt (line 2)) Cloning https://git.xfel.eu/gitlab/xfel-rtd/rtd-conf.git to /tmp/pip-req-build-8fl3d0ym Running command git clone -q https://git.xfel.eu/gitlab/xfel-rtd/rtd-conf.git /tmp/pip-req-build-8fl3d0ym Collecting sphinx==1.4.5 Downloading Sphinx-1.4.5-py2.py3-none-any.whl (1.6 MB) Collecting docutils==0.16 Downloading docutils-0.16-py2.py3-none-any.whl (548 kB) Collecting slumber Downloading slumber-0.7.1.tar.gz (10 kB) Collecting breathe Downloading breathe-4.26.1-py3-none-any.whl (80 kB) Requirement already satisfied: alabaster<0.8,>=0.7 in /usr/src/app/checkouts/readthedocs.org/user_builds/newsletter/envs/latest/lib/python3.6/site-packages (from sphinx==1.4.5->-r source/requirements.txt (line 1)) (0.7.12) Requirement already satisfied: Jinja2>=2.3 in /usr/src/app/checkouts/readthedocs.org/user_builds/newsletter/envs/latest/lib/python3.6/site-packages (from sphinx==1.4.5->-r source/requirements.txt (line 1)) (2.11.3) Requirement already satisfied: snowballstemmer>=1.1 in /usr/src/app/checkouts/readthedocs.org/user_builds/newsletter/envs/latest/lib/python3.6/site-packages (from sphinx==1.4.5->-r source/requirements.txt (line 1)) (2.1.0) Requirement already satisfied: Pygments>=2.0 in /usr/src/app/checkouts/readthedocs.org/user_builds/newsletter/envs/latest/lib/python3.6/site-packages (from sphinx==1.4.5->-r source/requirements.txt (line 1)) (2.3.1) Requirement already satisfied: six>=1.4 in /usr/src/app/checkouts/readthedocs.org/user_builds/newsletter/envs/latest/lib/python3.6/site-packages (from sphinx==1.4.5->-r source/requirements.txt (line 1)) (1.15.0) Requirement already satisfied: imagesize in /usr/src/app/checkouts/readthedocs.org/user_builds/newsletter/envs/latest/lib/python3.6/site-packages (from sphinx==1.4.5->-r source/requirements.txt (line 1)) (1.2.0) Requirement already satisfied: babel!=2.0,>=1.3 in /usr/src/app/checkouts/readthedocs.org/user_builds/newsletter/envs/latest/lib/python3.6/site-packages (from sphinx==1.4.5->-r source/requirements.txt (line 1)) (2.9.0) Requirement already satisfied: pytz>=2015.7 in /usr/src/app/checkouts/readthedocs.org/user_builds/newsletter/envs/latest/lib/python3.6/site-packages (from babel!=2.0,>=1.3->sphinx==1.4.5->-r source/requirements.txt (line 1)) (2021.1) Requirement already satisfied: MarkupSafe>=0.23 in /usr/src/app/checkouts/readthedocs.org/user_builds/newsletter/envs/latest/lib/python3.6/site-packages (from Jinja2>=2.3->sphinx==1.4.5->-r source/requirements.txt (line 1)) (1.1.1) Downloading breathe-4.26.0-py3-none-any.whl (80 kB) Downloading breathe-4.25.1-py3-none-any.whl (80 kB) Downloading breathe-4.25.0-py3-none-any.whl (80 kB) Downloading breathe-4.24.1-py3-none-any.whl (80 kB) Downloading breathe-4.24.0-py3-none-any.whl (80 kB) Downloading breathe-4.23.0-py3-none-any.whl (80 kB) Downloading breathe-4.22.1-py3-none-any.whl (80 kB) Downloading breathe-4.22.0-py3-none-any.whl (80 kB) Downloading breathe-4.21.0-py3-none-any.whl (80 kB) Downloading breathe-4.20.0-py3-none-any.whl (78 kB) Downloading breathe-4.19.2-py3-none-any.whl (78 kB) Downloading breathe-4.19.1-py3-none-any.whl (78 kB) Downloading breathe-4.19.0-py3-none-any.whl (78 kB) Downloading breathe-4.18.1-py3-none-any.whl (77 kB) Downloading breathe-4.18.0-py3-none-any.whl (76 kB) Downloading breathe-4.17.0-py3-none-any.whl (76 kB) Downloading breathe-4.16.0-py3-none-any.whl (74 kB) Downloading breathe-4.15.0-py3-none-any.whl (74 kB) Downloading breathe-4.14.2-py3-none-any.whl (74 kB) Downloading breathe-4.14.1-py3-none-any.whl (74 kB) Downloading breathe-4.14.0-py3-none-any.whl (74 kB) Downloading breathe-4.13.1-py3-none-any.whl (74 kB) Downloading breathe-4.13.0.post0-py3-none-any.whl (74 kB) Downloading breathe-4.13.0-py2.py3-none-any.whl (74 kB) Downloading breathe-4.12.0-py2.py3-none-any.whl (74 kB) Downloading breathe-4.11.1-py2.py3-none-any.whl (74 kB) Requirement already satisfied: requests in /usr/src/app/checkouts/readthedocs.org/user_builds/newsletter/envs/latest/lib/python3.6/site-packages (from slumber->-r source/requirements.txt (line 4)) (2.25.1) Requirement already satisfied: urllib3<1.27,>=1.21.1 in /usr/src/app/checkouts/readthedocs.org/user_builds/newsletter/envs/latest/lib/python3.6/site-packages (from requests->slumber->-r source/requirements.txt (line 4)) (1.26.3) Requirement already satisfied: idna<3,>=2.5 in /usr/src/app/checkouts/readthedocs.org/user_builds/newsletter/envs/latest/lib/python3.6/site-packages (from requests->slumber->-r source/requirements.txt (line 4)) (2.10) Requirement already satisfied: certifi>=2017.4.17 in /usr/src/app/checkouts/readthedocs.org/user_builds/newsletter/envs/latest/lib/python3.6/site-packages (from requests->slumber->-r source/requirements.txt (line 4)) (2020.12.5) Requirement already satisfied: chardet<5,>=3.0.2 in /usr/src/app/checkouts/readthedocs.org/user_builds/newsletter/envs/latest/lib/python3.6/site-packages (from requests->slumber->-r source/requirements.txt (line 4)) (4.0.0) Building wheels for collected packages: RTDConf, slumber Building wheel for RTDConf (setup.py): started Building wheel for RTDConf (setup.py): finished with status 'done' Created wheel for RTDConf: filename=RTDConf-0.1-py3-none-any.whl size=2667 sha256=057f5a533b4c049547ee89ca0d7dece0df9e48562bb85756eef8e46d9b432750 Stored in directory: /tmp/pip-ephem-wheel-cache-7weeiglf/wheels/96/5c/8e/c7d15deed053c815480ca7a9ca8554a79e58503d16dffa1f92 Building wheel for slumber (setup.py): started Building wheel for slumber (setup.py): finished with status 'done' Created wheel for slumber: filename=slumber-0.7.1-py3-none-any.whl size=8098 sha256=96dbe63ef19fd19720904a7c6f61cc73cd9da7305279e1d63a56aff110549b5b Stored in directory: /tmp/pip-ephem-wheel-cache-7weeiglf/wheels/36/70/2b/f169553f052c68fb9fea8ed83d9f4a1d09f0519d4ec35e8519 Successfully built RTDConf slumber Installing collected packages: docutils, sphinx, slumber, RTDConf, breathe Attempting uninstall: docutils Found existing installation: docutils 0.14 Uninstalling docutils-0.14: Successfully uninstalled docutils-0.14 Attempting uninstall: sphinx Found existing installation: Sphinx 1.8.5 Uninstalling Sphinx-1.8.5: Successfully uninstalled Sphinx-1.8.5 Successfully installed RTDConf-0.1 breathe-4.11.1 docutils-0.16 slumber-0.7.1 sphinx-1.4.5 [rtd-command-info] start-time: 2021-02-08T16:21:26.028314Z, end-time: 2021-02-08T16:21:26.101758Z, duration: 0, exit-code: 0 cat source/conf.py #!/usr/bin/env python3 # -*- coding: utf-8 -*- # # 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. # # -- General configuration ------------------------------------------------ # If your documentation needs a minimal Sphinx version, state it here. # # needs_sphinx = '1.0' # Add any Sphinx extension module names here, as strings. They can be # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom # ones. extensions = [ 'sphinx.ext.autodoc', 'sphinx.ext.intersphinx', 'sphinx.ext.todo', 'sphinx.ext.mathjax', 'sphinx.ext.ifconfig', 'sphinx.ext.viewcode', 'sphinx.ext.graphviz', ] # 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 = 'KaraboNewsletter' copyright = '2019, CAS' author = 'CAS' # 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 = [] # 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 = 'KaraboNewsletter v1.0' # 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 = 'CAS-KaraboNewsletter' # -- Options for LaTeX output --------------------------------------------- latex_engine = 'pdflatex' latex_elements = { # The paper size ('letterpaper' or 'a4paper'). # 'papersize': 'a4paper', 'fncychap': '\\usepackage{fncychap}', # The font size ('10pt', '11pt' or '12pt'). # 'pointsize': '10pt', # Additional stuff for the LaTeX preamble. # 'preamble': '', # Latex figure (float) alignment # 'figure_align': 'hbt!', 'sphinxsetup': \ 'hmargin={0.7in,0.7in}, vmargin={1in,1in}, \ verbatimwithframe=true, \ TitleColor={rgb}{0,0,0}, \ HeaderFamily=\\rmfamily\\bfseries, \ InnerLinkColor={rgb}{0,0,1}, \ OuterLinkColor={rgb}{0,0,1}', 'tableofcontents': ' ', 'extraclassoptions': 'openany,oneside', # remove blanks 'maketitle': '', # No Title Page } # 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, 'KaraboNewsletter.tex', 'KaraboNewsletter', 'CAS', 'howto'), ] # 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, 'cas-KaraboNewsletter', 'KaraboNewsletter 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, 'KaraboNewsletter', 'KaraboNewsletter Documentation', author, 'KaraboNewsletter', '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 ########################################################################### # auto-created readthedocs.org specific configuration # ########################################################################### # # The following code was added during an automated build on readthedocs.org # It is auto created and injected for every build. The result is based on the # conf.py.tmpl file found in the readthedocs.org codebase: # https://github.com/rtfd/readthedocs.org/blob/master/readthedocs/doc_builder/templates/doc_builder/conf.py.tmpl # import importlib import sys import os.path from six import string_types from sphinx import version_info # Get suffix for proper linking to GitHub # This is deprecated in Sphinx 1.3+, # as each page can have its own suffix if globals().get('source_suffix', False): if isinstance(source_suffix, string_types): SUFFIX = source_suffix elif isinstance(source_suffix, (list, tuple)): # Sphinx >= 1.3 supports list/tuple to define multiple suffixes SUFFIX = source_suffix[0] elif isinstance(source_suffix, dict): # Sphinx >= 1.8 supports a mapping dictionary for multiple suffixes SUFFIX = list(source_suffix.keys())[0] # make a ``list()`` for py2/py3 compatibility else: # default to .rst SUFFIX = '.rst' else: SUFFIX = '.rst' # Add RTD Static Path. Add to the end because it overwrites previous files. if not 'html_static_path' in globals(): html_static_path = [] if os.path.exists('_static'): html_static_path.append('_static') # Add RTD Theme only if they aren't overriding it already using_rtd_theme = ( ( 'html_theme' in globals() and html_theme in ['default'] and # Allow people to bail with a hack of having an html_style 'html_style' not in globals() ) or 'html_theme' not in globals() ) if using_rtd_theme: theme = importlib.import_module('sphinx_rtd_theme') html_theme = 'sphinx_rtd_theme' html_style = None html_theme_options = {} if 'html_theme_path' in globals(): html_theme_path.append(theme.get_html_theme_path()) else: html_theme_path = [theme.get_html_theme_path()] if globals().get('websupport2_base_url', False): websupport2_base_url = 'http://rtd.xfel.eu/websupport' websupport2_static_url = '/static/' #Add project information to the template context. context = { 'using_theme': using_rtd_theme, 'html_theme': html_theme, 'current_version': "latest", 'version_slug': "latest", 'MEDIA_URL': "media/", 'STATIC_URL': "/static/", 'PRODUCTION_DOMAIN': "rtd.xfel.eu", 'versions': [ ("latest", "/en/latest/"), ], 'downloads': [ ], 'subprojects': [ ], 'slug': 'newsletter', 'name': u'Newsletter', 'rtd_language': u'en', 'programming_language': u'words', 'canonical_url': 'http://rtd.xfel.eu/docs/newsletter/en/latest/', 'analytics_code': 'None', 'single_version': False, 'conf_py_path': '/source/', 'api_host': 'http://rtd.xfel.eu', 'github_user': 'None', 'proxied_api_host': '/_', 'github_repo': 'None', 'github_version': 'master', 'display_github': False, 'bitbucket_user': 'None', 'bitbucket_repo': 'None', 'bitbucket_version': 'master', 'display_bitbucket': False, 'gitlab_user': 'None', 'gitlab_repo': 'None', 'gitlab_version': 'master', 'display_gitlab': False, 'READTHEDOCS': True, 'using_theme': (html_theme == "default"), 'new_theme': (html_theme == "sphinx_rtd_theme"), 'source_suffix': SUFFIX, 'ad_free': False, 'docsearch_disabled': False, 'user_analytics_code': '', 'global_analytics_code': 'None', 'commit': 'f68aa5dd', } if 'html_context' in globals(): html_context.update(context) else: html_context = context # Add custom RTD extension if 'extensions' in globals(): # Insert at the beginning because it can interfere # with other extensions. # See https://github.com/rtfd/readthedocs.org/pull/4054 extensions.insert(0, "readthedocs_ext.readthedocs") else: extensions = ["readthedocs_ext.readthedocs"] # Add External version warning banner to the external version documentation if 'branch' == 'external': extensions.insert(1, "readthedocs_ext.external_version_warning") project_language = 'en' # User's Sphinx configurations language_user = globals().get('language', None) latex_engine_user = globals().get('latex_engine', None) latex_elements_user = globals().get('latex_elements', None) # Remove this once xindy gets installed in Docker image and XINDYOPS # env variable is supported # https://github.com/rtfd/readthedocs-docker-images/pull/98 latex_use_xindy = False chinese = any([ language_user in ('zh_CN', 'zh_TW'), project_language in ('zh_CN', 'zh_TW'), ]) japanese = any([ language_user == 'ja', project_language == 'ja', ]) if chinese: latex_engine = latex_engine_user or 'xelatex' latex_elements_rtd = { 'preamble': '\\usepackage[UTF8]{ctex}\n', } latex_elements = latex_elements_user or latex_elements_rtd elif japanese: latex_engine = latex_engine_user or 'platex' # Make sure our build directory is always excluded exclude_patterns = globals().get('exclude_patterns', []) exclude_patterns.extend(['_build']) [rtd-command-info] start-time: 2021-02-08T16:21:26.247596Z, end-time: 2021-02-08T16:21:28.320803Z, duration: 2, exit-code: 1 python /usr/src/app/checkouts/readthedocs.org/user_builds/newsletter/envs/latest/bin/sphinx-build -T -b readthedocs -d _build/doctrees-readthedocs -D language=en . _build/html Running Sphinx v1.4.5 making output directory... loading translations [en]... done loading pickled environment... not yet created building [mo]: targets for 0 po files that are out of date building [readthedocs]: targets for 26 source files that are out of date updating environment: 26 added, 0 changed, 0 removed reading sources... [ 3%] index reading sources... [ 7%] ticker_01 reading sources... [ 11%] ticker_02 reading sources... [ 15%] ticker_03 reading sources... [ 19%] ticker_04 reading sources... [ 23%] ticker_05 reading sources... [ 26%] ticker_06 reading sources... [ 30%] ticker_07 reading sources... [ 34%] ticker_08 reading sources... [ 38%] ticker_09 reading sources... [ 42%] ticker_10 reading sources... [ 46%] ticker_11 reading sources... [ 50%] ticker_12 reading sources... [ 53%] ticker_13 reading sources... [ 57%] ticker_14 reading sources... [ 61%] ticker_15 reading sources... [ 65%] ticker_16 reading sources... [ 69%] ticker_17 reading sources... [ 73%] ticker_18 reading sources... [ 76%] ticker_19 reading sources... [ 80%] ticker_20 reading sources... [ 84%] ticker_21 reading sources... [ 88%] ticker_22 reading sources... [ 92%] ticker_23 reading sources... [ 96%] ticker_24 reading sources... [100%] ticker_25 looking for now-outdated files... none found pickling environment... done checking consistency... done preparing documents... done writing output... [ 3%] index writing output... [ 7%] ticker_01 writing output... [ 11%] ticker_02 writing output... [ 15%] ticker_03 writing output... [ 19%] ticker_04 writing output... [ 23%] ticker_05 writing output... [ 26%] ticker_06 writing output... [ 30%] ticker_07 writing output... [ 34%] ticker_08 writing output... [ 38%] ticker_09 writing output... [ 42%] ticker_10 writing output... [ 46%] ticker_11 writing output... [ 50%] ticker_12 writing output... [ 53%] ticker_13 writing output... [ 57%] ticker_14 writing output... [ 61%] ticker_15 writing output... [ 65%] ticker_16 writing output... [ 69%] ticker_17 writing output... [ 73%] ticker_18 writing output... [ 76%] ticker_19 /usr/src/app/checkouts/readthedocs.org/user_builds/newsletter/envs/latest/lib/python3.6/site-packages/sphinx/domains/std.py:554: FutureWarning: The iterable returned by Node.traverse() will become an iterator instead of a list in Docutils > 0.16. n = node.traverse(addnodes.toctree)[0] /usr/src/app/checkouts/readthedocs.org/user_builds/newsletter/envs/latest/lib/python3.6/site-packages/sphinx/util/nodes.py:51: FutureWarning: The iterable returned by Node.traverse() will become an iterator instead of a list in Docutils > 0.16. for classifier in reversed(node.parent.traverse(nodes.classifier)): /usr/src/app/checkouts/readthedocs.org/user_builds/newsletter/envs/latest/lib/python3.6/site-packages/sphinx/writers/html.py:352: FutureWarning: The iterable returned by Node.traverse() will become an iterator instead of a list in Docutils > 0.16. target_node = image_nodes and image_nodes[0] or node.parent Traceback (most recent call last): File "/usr/src/app/checkouts/readthedocs.org/user_builds/newsletter/envs/latest/lib/python3.6/site-packages/sphinx/cmdline.py", line 244, in main app.build(opts.force_all, filenames) File "/usr/src/app/checkouts/readthedocs.org/user_builds/newsletter/envs/latest/lib/python3.6/site-packages/sphinx/application.py", line 297, in build self.builder.build_update() File "/usr/src/app/checkouts/readthedocs.org/user_builds/newsletter/envs/latest/lib/python3.6/site-packages/sphinx/builders/__init__.py", line 251, in build_update 'out of date' % len(to_build)) File "/usr/src/app/checkouts/readthedocs.org/user_builds/newsletter/envs/latest/lib/python3.6/site-packages/sphinx/builders/__init__.py", line 322, in build self.write(docnames, list(updated_docnames), method) File "/usr/src/app/checkouts/readthedocs.org/user_builds/newsletter/envs/latest/lib/python3.6/site-packages/sphinx/builders/__init__.py", line 360, in write self._write_serial(sorted(docnames), warnings) File "/usr/src/app/checkouts/readthedocs.org/user_builds/newsletter/envs/latest/lib/python3.6/site-packages/sphinx/builders/__init__.py", line 368, in _write_serial self.write_doc(docname, doctree) File "/usr/src/app/checkouts/readthedocs.org/user_builds/newsletter/envs/latest/lib/python3.6/site-packages/sphinx/builders/html.py", line 446, in write_doc self.docwriter.write(doctree, destination) File "/usr/src/app/checkouts/readthedocs.org/user_builds/newsletter/envs/latest/lib/python3.6/site-packages/docutils/writers/__init__.py", line 78, in write self.translate() File "/usr/src/app/checkouts/readthedocs.org/user_builds/newsletter/envs/latest/lib/python3.6/site-packages/sphinx/writers/html.py", line 47, in translate self.document.walkabout(visitor) File "/usr/src/app/checkouts/readthedocs.org/user_builds/newsletter/envs/latest/lib/python3.6/site-packages/docutils/nodes.py", line 227, in walkabout visitor.dispatch_departure(self) File "/usr/src/app/checkouts/readthedocs.org/user_builds/newsletter/envs/latest/lib/python3.6/site-packages/docutils/nodes.py", line 2008, in dispatch_departure return method(node) File "/usr/src/app/checkouts/readthedocs.org/user_builds/newsletter/envs/latest/lib/python3.6/site-packages/docutils/writers/_html_base.py", line 746, in depart_document assert not self.context, 'len(context) = %s' % len(self.context) AssertionError: len(context) = 3 Exception occurred: File "/usr/src/app/checkouts/readthedocs.org/user_builds/newsletter/envs/latest/lib/python3.6/site-packages/docutils/writers/_html_base.py", line 746, in depart_document assert not self.context, 'len(context) = %s' % len(self.context) AssertionError: len(context) = 3 The full traceback has been saved in /tmp/sphinx-err-zb9n9qm5.log, if you want to report the issue to the developers. Please also report this if it was a user error, so that a better error message can be provided next time. A bug report can be filed in the tracker at . Thanks!