Read the Docs build information Build id: 23437 Project: dssc-operation-manual Version: latest Commit: 1bb5b09fe29b701a7e1a662fb32a690381b83af5 Date: 2022-04-12T11:05:47.516465Z State: finished Success: False [rtd-command-info] start-time: 2022-04-12T11:05:48.811916Z, end-time: 2022-04-12T11:05:49.964250Z, duration: 1, exit-code: 0 git clone --no-single-branch --depth 50 http://git.xfel.eu/gitlab/detectors/dssc_documentation.git . Cloning into '.'... [rtd-command-info] start-time: 2022-04-12T11:05:50.352926Z, end-time: 2022-04-12T11:05:50.477971Z, 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 1bb5b09 Merge branch 'expert' into 'master' [rtd-command-info] start-time: 2022-04-12T11:05:50.621217Z, end-time: 2022-04-12T11:05:50.701659Z, duration: 0, exit-code: 0 git clean -d -f -f [rtd-command-info] start-time: 2022-04-12T11:05:52.458474Z, end-time: 2022-04-12T11:06:00.115153Z, duration: 7, exit-code: 0 python3.7 -mvirtualenv /usr/src/app/checkouts/readthedocs.org/user_builds/dssc-operation-manual/envs/latest Using base prefix '/home/docs/.pyenv/versions/3.7.3' New python executable in /usr/src/app/checkouts/readthedocs.org/user_builds/dssc-operation-manual/envs/latest/bin/python3.7 Also creating executable in /usr/src/app/checkouts/readthedocs.org/user_builds/dssc-operation-manual/envs/latest/bin/python Installing setuptools, pip, wheel... done. [rtd-command-info] start-time: 2022-04-12T11:06:00.248210Z, end-time: 2022-04-12T11:06:01.558201Z, duration: 1, exit-code: 0 /usr/src/app/checkouts/readthedocs.org/user_builds/dssc-operation-manual/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/dssc-operation-manual/envs/latest/lib/python3.7/site-packages (22.0.4) [rtd-command-info] start-time: 2022-04-12T11:06:01.696309Z, end-time: 2022-04-12T11:06:18.287890Z, duration: 16, exit-code: 0 /usr/src/app/checkouts/readthedocs.org/user_builds/dssc-operation-manual/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) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 849.5/849.5 KB 10.9 MB/s eta 0:00:00 Collecting setuptools==41.0.1 Downloading setuptools-41.0.1-py2.py3-none-any.whl (575 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 576.0/576.0 KB 128.6 MB/s eta 0:00:00 Collecting docutils==0.14 Downloading docutils-0.14-py3-none-any.whl (543 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 543.2/543.2 KB 122.9 MB/s eta 0:00:00 Collecting mock==1.0.1 Downloading mock-1.0.1.zip (861 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 861.9/861.9 KB 120.1 MB/s eta 0:00:00 Preparing metadata (setup.py): started Preparing metadata (setup.py): finished with status 'done' Collecting pillow==5.4.1 Downloading Pillow-5.4.1-cp37-cp37m-manylinux1_x86_64.whl (2.0 MB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 2.0/2.0 MB 111.9 MB/s eta 0:00:00 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) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 47.4/47.4 KB 124.9 MB/s eta 0:00:00 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.6-py2.py3-none-any.whl (3.1 MB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 3.1/3.1 MB 124.7 MB/s eta 0:00:00 Collecting sphinx-rtd-theme<0.5 Downloading sphinx_rtd_theme-0.4.3-py2.py3-none-any.whl (6.4 MB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 6.4/6.4 MB 130.0 MB/s eta 0:00:00 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) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 829.2/829.2 KB 137.8 MB/s eta 0:00:00 Preparing metadata (setup.py): started Preparing metadata (setup.py): finished with status 'done' Collecting sphinxcontrib-websupport Downloading sphinxcontrib_websupport-1.2.4-py2.py3-none-any.whl (39 kB) Collecting packaging Downloading packaging-21.3-py3-none-any.whl (40 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 40.8/40.8 KB 104.8 MB/s eta 0:00:00 Collecting six>=1.5 Downloading six-1.16.0-py2.py3-none-any.whl (11 kB) Collecting imagesize Downloading imagesize-1.3.0-py2.py3-none-any.whl (5.2 kB) Collecting requests>=2.0.0 Downloading requests-2.27.1-py2.py3-none-any.whl (63 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 63.1/63.1 KB 122.9 MB/s eta 0:00:00 Collecting babel!=2.0,>=1.3 Downloading Babel-2.9.1-py2.py3-none-any.whl (8.8 MB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 8.8/8.8 MB 128.8 MB/s eta 0:00:00 Collecting snowballstemmer>=1.1 Downloading snowballstemmer-2.2.0-py2.py3-none-any.whl (93 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 93.0/93.0 KB 120.4 MB/s eta 0:00:00 Collecting Jinja2>=2.3 Downloading Jinja2-3.1.1-py3-none-any.whl (132 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 132.6/132.6 KB 130.7 MB/s eta 0:00:00 Collecting pytz>=2015.7 Downloading pytz-2022.1-py2.py3-none-any.whl (503 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 503.5/503.5 KB 139.4 MB/s eta 0:00:00 Collecting MarkupSafe>=2.0 Downloading MarkupSafe-2.1.1-cp37-cp37m-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (25 kB) Collecting idna<4,>=2.5 Downloading idna-3.3-py3-none-any.whl (61 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 61.2/61.2 KB 120.2 MB/s eta 0:00:00 Collecting certifi>=2017.4.17 Downloading certifi-2021.10.8-py2.py3-none-any.whl (149 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 149.2/149.2 KB 113.8 MB/s eta 0:00:00 Collecting charset-normalizer~=2.0.0 Downloading charset_normalizer-2.0.12-py3-none-any.whl (39 kB) Collecting urllib3<1.27,>=1.21.1 Downloading urllib3-1.26.9-py2.py3-none-any.whl (138 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 139.0/139.0 KB 130.0 MB/s eta 0:00:00 Collecting pyparsing!=3.0.5,>=2.0.2 Downloading pyparsing-3.0.8-py3-none-any.whl (98 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 98.5/98.5 KB 130.2 MB/s eta 0:00:00 Collecting sphinxcontrib-serializinghtml Downloading sphinxcontrib_serializinghtml-1.1.5-py2.py3-none-any.whl (94 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 94.0/94.0 KB 133.2 MB/s eta 0:00:00 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=23773 sha256=417ab5aef415e3251d8af8bcfd109902cea27d2e1ff4044c08c2ce9a7bd5ac51 Stored in directory: /tmp/pip-ephem-wheel-cache-hh10z8ym/wheels/7a/94/b1/0fdc5339a5bd487a5cc15421ec200d9ba3e2aa7190e4a727f1 Building wheel for future (setup.py): started Building wheel for future (setup.py): finished with status 'done' Created wheel for future: filename=future-0.18.2-py3-none-any.whl size=491070 sha256=b3cc5702dfb12d8d7577bcef9fed057358b95de6a89c9fce8ddf61d32809f4e3 Stored in directory: /tmp/pip-ephem-wheel-cache-hh10z8ym/wheels/56/b0/fe/4410d17b32f1f0c3cf54cdfb2bc04d7b4b8f4ae377e2229ba0 Successfully built mock future Installing collected packages: snowballstemmer, pytz, Pygments, mock, docutils, certifi, alabaster, urllib3, sphinxcontrib-serializinghtml, six, setuptools, pyparsing, pillow, MarkupSafe, imagesize, idna, future, charset-normalizer, babel, sphinxcontrib-websupport, requests, packaging, Jinja2, commonmark, sphinx, readthedocs-sphinx-ext, sphinx-rtd-theme, recommonmark Attempting uninstall: setuptools Found existing installation: setuptools 62.1.0 Uninstalling setuptools-62.1.0: Successfully uninstalled setuptools-62.1.0 Successfully installed Jinja2-3.1.1 MarkupSafe-2.1.1 Pygments-2.3.1 alabaster-0.7.12 babel-2.9.1 certifi-2021.10.8 charset-normalizer-2.0.12 commonmark-0.8.1 docutils-0.14 future-0.18.2 idna-3.3 imagesize-1.3.0 mock-1.0.1 packaging-21.3 pillow-5.4.1 pyparsing-3.0.8 pytz-2022.1 readthedocs-sphinx-ext-1.0.4 recommonmark-0.5.0 requests-2.27.1 setuptools-41.0.1 six-1.16.0 snowballstemmer-2.2.0 sphinx-1.8.6 sphinx-rtd-theme-0.4.3 sphinxcontrib-serializinghtml-1.1.5 sphinxcontrib-websupport-1.2.4 urllib3-1.26.9 [rtd-command-info] start-time: 2022-04-12T11:06:18.420518Z, end-time: 2022-04-12T11:06:23.086510Z, duration: 4, exit-code: 0 /usr/src/app/checkouts/readthedocs.org/user_builds/dssc-operation-manual/envs/latest/bin/python -m pip install --exists-action=w --no-cache-dir -r requirements.txt Collecting git+https://git.xfel.eu/gitlab/xfel-rtd/rtd-conf.git (from -r requirements.txt (line 3)) Cloning https://git.xfel.eu/gitlab/xfel-rtd/rtd-conf.git to /tmp/pip-req-build-1hi7aa8e Running command git clone --filter=blob:none --quiet https://git.xfel.eu/gitlab/xfel-rtd/rtd-conf.git /tmp/pip-req-build-1hi7aa8e Resolved https://git.xfel.eu/gitlab/xfel-rtd/rtd-conf.git to commit 3d66246db37045eaa716d206b13441613c1b413e Preparing metadata (setup.py): started Preparing metadata (setup.py): finished with status 'done' Collecting sphinx==1.4.5 Downloading Sphinx-1.4.5-py2.py3-none-any.whl (1.6 MB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 1.6/1.6 MB 16.8 MB/s eta 0:00:00 Collecting breathe==4.7.3 Downloading breathe-4.7.3-py2.py3-none-any.whl (73 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 73.7/73.7 KB 95.7 MB/s eta 0:00:00 Collecting slumber==0.7.1 Downloading slumber-0.7.1.tar.gz (10 kB) Preparing metadata (setup.py): started Preparing metadata (setup.py): finished with status 'done' Requirement already satisfied: six>=1.4 in /usr/src/app/checkouts/readthedocs.org/user_builds/dssc-operation-manual/envs/latest/lib/python3.7/site-packages (from sphinx==1.4.5->-r requirements.txt (line 4)) (1.16.0) Requirement already satisfied: snowballstemmer>=1.1 in /usr/src/app/checkouts/readthedocs.org/user_builds/dssc-operation-manual/envs/latest/lib/python3.7/site-packages (from sphinx==1.4.5->-r requirements.txt (line 4)) (2.2.0) Requirement already satisfied: alabaster<0.8,>=0.7 in /usr/src/app/checkouts/readthedocs.org/user_builds/dssc-operation-manual/envs/latest/lib/python3.7/site-packages (from sphinx==1.4.5->-r requirements.txt (line 4)) (0.7.12) Requirement already satisfied: Pygments>=2.0 in /usr/src/app/checkouts/readthedocs.org/user_builds/dssc-operation-manual/envs/latest/lib/python3.7/site-packages (from sphinx==1.4.5->-r requirements.txt (line 4)) (2.3.1) Requirement already satisfied: Jinja2>=2.3 in /usr/src/app/checkouts/readthedocs.org/user_builds/dssc-operation-manual/envs/latest/lib/python3.7/site-packages (from sphinx==1.4.5->-r requirements.txt (line 4)) (3.1.1) Requirement already satisfied: imagesize in /usr/src/app/checkouts/readthedocs.org/user_builds/dssc-operation-manual/envs/latest/lib/python3.7/site-packages (from sphinx==1.4.5->-r requirements.txt (line 4)) (1.3.0) Requirement already satisfied: docutils>=0.11 in /usr/src/app/checkouts/readthedocs.org/user_builds/dssc-operation-manual/envs/latest/lib/python3.7/site-packages (from sphinx==1.4.5->-r requirements.txt (line 4)) (0.14) Requirement already satisfied: babel!=2.0,>=1.3 in /usr/src/app/checkouts/readthedocs.org/user_builds/dssc-operation-manual/envs/latest/lib/python3.7/site-packages (from sphinx==1.4.5->-r requirements.txt (line 4)) (2.9.1) Requirement already satisfied: requests in /usr/src/app/checkouts/readthedocs.org/user_builds/dssc-operation-manual/envs/latest/lib/python3.7/site-packages (from slumber==0.7.1->-r requirements.txt (line 6)) (2.27.1) Requirement already satisfied: pytz>=2015.7 in /usr/src/app/checkouts/readthedocs.org/user_builds/dssc-operation-manual/envs/latest/lib/python3.7/site-packages (from babel!=2.0,>=1.3->sphinx==1.4.5->-r requirements.txt (line 4)) (2022.1) Requirement already satisfied: MarkupSafe>=2.0 in /usr/src/app/checkouts/readthedocs.org/user_builds/dssc-operation-manual/envs/latest/lib/python3.7/site-packages (from Jinja2>=2.3->sphinx==1.4.5->-r requirements.txt (line 4)) (2.1.1) Requirement already satisfied: certifi>=2017.4.17 in /usr/src/app/checkouts/readthedocs.org/user_builds/dssc-operation-manual/envs/latest/lib/python3.7/site-packages (from requests->slumber==0.7.1->-r requirements.txt (line 6)) (2021.10.8) Requirement already satisfied: urllib3<1.27,>=1.21.1 in /usr/src/app/checkouts/readthedocs.org/user_builds/dssc-operation-manual/envs/latest/lib/python3.7/site-packages (from requests->slumber==0.7.1->-r requirements.txt (line 6)) (1.26.9) Requirement already satisfied: charset-normalizer~=2.0.0 in /usr/src/app/checkouts/readthedocs.org/user_builds/dssc-operation-manual/envs/latest/lib/python3.7/site-packages (from requests->slumber==0.7.1->-r requirements.txt (line 6)) (2.0.12) Requirement already satisfied: idna<4,>=2.5 in /usr/src/app/checkouts/readthedocs.org/user_builds/dssc-operation-manual/envs/latest/lib/python3.7/site-packages (from requests->slumber==0.7.1->-r requirements.txt (line 6)) (3.3) Building wheels for collected packages: slumber, RTDConf 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=aca6f083b1136479bf6e23fa041a3bdeea06f5710bfeea0a27d86e6eaeb14796 Stored in directory: /tmp/pip-ephem-wheel-cache-yaweduvb/wheels/eb/d6/67/f165e383ef89df4d90f29343f2e120543adc1886663e9f139b 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=2648 sha256=eecb9862e86b958d8ab3e5c747401c5e1eaa4919b11a9b30121492d2b9b5eb52 Stored in directory: /tmp/pip-ephem-wheel-cache-yaweduvb/wheels/17/a3/d4/e42b943fdbccc9aa92ab080ea1739cd6987c6c6d000fb359e4 Successfully built slumber RTDConf Installing collected packages: RTDConf, sphinx, slumber, breathe Attempting uninstall: sphinx Found existing installation: Sphinx 1.8.6 Uninstalling Sphinx-1.8.6: Successfully uninstalled Sphinx-1.8.6 Successfully installed RTDConf-0.1 breathe-4.7.3 slumber-0.7.1 sphinx-1.4.5 [rtd-command-info] start-time: 2022-04-12T11:06:24.144820Z, end-time: 2022-04-12T11:06:24.221899Z, duration: 0, exit-code: 0 cat source/conf.py #!/usr/bin/env python3.8.3 # -*- coding: utf-8 -*- # # pnCCD documentation build configuration file, created by # sphinx-quickstart on Tuesday January 28, 2020 at 11:25:48. # # This file is execfile()d with the current directory set to its # containing directory. # # 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 # -- 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', 'sphinx.ext.autosectionlabel', ] # Ensure that autosectionlabel will produce unique names autosectionlabel_prefix_document = True autosectionlabel_maxdepth = 4 # 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 = 'DSSC' copyright = '2020, XFEL Detector Operation Group' #author = 'XFEL Detector Group' author = u'David Lomidze, Monica Turcato' # 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 = ': Version 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' # If True, figures, tables and code-blocks are automatically numbered if they # have a caption. The numref role is enabled. Obeyed so far only by HTML and # LaTeX builders. Default is False. numfig = True # 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 = 'The DSSC Detector Operation Manual' # A shorter title for the navigation bar. Default is the same as html_title. # html_short_title = "DSSC Manual" # 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'] html_static_path = ['_static'] # ['_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 = 'DSSCdoc' # -- 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': # To get rid of blank pages after each chapter: 'extraclassoptions': 'openany,oneside,dvipsnames', 'preamble': r'''\newcommand{\docutilsrolemybold}{\bfseries} \newcommand{\DUrolered}[1]{{\color{Red}#1}} \newcommand{\DUroleblue}[1]{{\color{Blue}#1}} \newcommand{\DUrolegreen}[1]{{\color{Green}#1}} \newcommand{\DUroleyellow}[1]{{\color{Yellow}#1}} ''' # 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, 'pnCCD.tex', 'pnCCD Documentation', # 'XFEL Detector Group', 'manual'), #] latex_documents = [ (master_doc, 'DSSC.tex', 'The DSSC Operation Manual', 'David Lomidze, Monica Turcato', '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, 'dssc', 'The DSSC Operation Manual', [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, 'DSSC', 'The DSSC Operation Manual', author, 'DSSC', 'This is the DSSC detector operation manual.', '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://rtd.xfel.eu/' api = slumber.API(base_url='{}/api/v2/'.format(RTDHOST)) projects = api.project.get()['results'] isphinx = {'python': ('http://python.readthedocs.io/en/latest/', None), 'numpy': ('http://numpy.readthedocs.io/en/latest/', None), 'scipy': ('http://scipy.readthedocs.io/en/latest/', None)} for proj in projects: isphinx[proj['slug'].replace('-', '')] = \ ('{}/docs/{}/en/latest'.format(RTDHOST, proj['slug']), None) #intersphinx_mapping = isphinx intersphinx_mapping = {'https://docs.python.org/': None} 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 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': [ ("pdf", "//rtd.xfel.eu/downloads/dssc-operation-manual/latest/pdf/"), ("html", "//rtd.xfel.eu/downloads/dssc-operation-manual/latest/htmlzip/"), ("epub", "//rtd.xfel.eu/downloads/dssc-operation-manual/latest/epub/"), ], 'subprojects': [ ], 'slug': 'dssc-operation-manual', 'name': u'DSSC Operation Manual', 'rtd_language': u'en', 'programming_language': u'words', 'canonical_url': 'http://rtd.xfel.eu/docs/dssc-operation-manual/en/latest/', 'analytics_code': '', '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': '1bb5b09f', } 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: 2022-04-12T11:06:24.351622Z, end-time: 2022-04-12T11:06:26.364565Z, duration: 2, exit-code: 1 python /usr/src/app/checkouts/readthedocs.org/user_builds/dssc-operation-manual/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 Traceback (most recent call last): File "/usr/src/app/checkouts/readthedocs.org/user_builds/dssc-operation-manual/envs/latest/lib/python3.7/site-packages/sphinx/cmdline.py", line 243, in main opts.warningiserror, opts.tags, opts.verbosity, opts.jobs) File "/usr/src/app/checkouts/readthedocs.org/user_builds/dssc-operation-manual/envs/latest/lib/python3.7/site-packages/sphinx/application.py", line 204, in __init__ self._init_builder(self.buildername) File "/usr/src/app/checkouts/readthedocs.org/user_builds/dssc-operation-manual/envs/latest/lib/python3.7/site-packages/sphinx/application.py", line 278, in _init_builder self.builder = builderclass(self) File "/usr/src/app/checkouts/readthedocs.org/user_builds/dssc-operation-manual/envs/latest/lib/python3.7/site-packages/sphinx/builders/__init__.py", line 87, in __init__ self.init() File "/usr/src/app/checkouts/readthedocs.org/user_builds/dssc-operation-manual/envs/latest/lib/python3.7/site-packages/sphinx/builders/html.py", line 107, in init self.init_templates() File "/usr/src/app/checkouts/readthedocs.org/user_builds/dssc-operation-manual/envs/latest/lib/python3.7/site-packages/sphinx/builders/html.py", line 144, in init_templates self.create_template_bridge() File "/usr/src/app/checkouts/readthedocs.org/user_builds/dssc-operation-manual/envs/latest/lib/python3.7/site-packages/sphinx/builders/__init__.py", line 102, in create_template_bridge from sphinx.jinja2glue import BuiltinTemplateLoader File "/usr/src/app/checkouts/readthedocs.org/user_builds/dssc-operation-manual/envs/latest/lib/python3.7/site-packages/sphinx/jinja2glue.py", line 16, in from jinja2 import FileSystemLoader, BaseLoader, TemplateNotFound, \ ImportError: cannot import name 'contextfunction' from 'jinja2' (/usr/src/app/checkouts/readthedocs.org/user_builds/dssc-operation-manual/envs/latest/lib/python3.7/site-packages/jinja2/__init__.py) Exception occurred: File "/usr/src/app/checkouts/readthedocs.org/user_builds/dssc-operation-manual/envs/latest/lib/python3.7/site-packages/sphinx/jinja2glue.py", line 16, in from jinja2 import FileSystemLoader, BaseLoader, TemplateNotFound, \ ImportError: cannot import name 'contextfunction' from 'jinja2' (/usr/src/app/checkouts/readthedocs.org/user_builds/dssc-operation-manual/envs/latest/lib/python3.7/site-packages/jinja2/__init__.py) The full traceback has been saved in /tmp/sphinx-err-k76aoje2.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!