Read the Docs build information Build id: 20980 Project: pnccd-analysis-manual Version: latest Commit: f3103ba88f684e094b8358f1c015128ffe34e1a0 Date: 2020-12-05T09:41:32.510653Z State: finished Success: False [rtd-command-info] start-time: 2020-12-05T15:41:34.807000Z, end-time: 2020-12-05T15:41:48.501000Z, duration: 13, exit-code: 0 python3 -mvirtualenv --no-site-packages --no-download /user_builds/pnccd-analysis-manual/envs/latest Using base prefix '/usr' New python executable in /user_builds/pnccd-analysis-manual/envs/latest/bin/python3 Not overwriting existing python script /user_builds/pnccd-analysis-manual/envs/latest/bin/python (you must use /user_builds/pnccd-analysis-manual/envs/latest/bin/python3) Installing setuptools, pip, wheel...done. Overwriting /user_builds/pnccd-analysis-manual/envs/latest/bin/activate.fish with new content [rtd-command-info] start-time: 2020-12-05T15:41:48.562000Z, end-time: 2020-12-05T15:43:41.192000Z, duration: 112, exit-code: 0 python /user_builds/pnccd-analysis-manual/envs/latest/bin/pip install --use-wheel -U --cache-dir /user_builds/pnccd-analysis-manual/.cache/pip sphinx==1.3.5 Pygments==2.1.3 setuptools==20.1.1 docutils==0.12 mkdocs==0.15.0 PyYAML==5.2 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 Collecting Pygments==2.1.3 Using cached https://files.pythonhosted.org/packages/9e/d0/d692085518c6a2dc875fe421c866fb6a08e0d9796ca507803c1e545fa116/Pygments-2.1.3-py2.py3-none-any.whl Collecting setuptools==20.1.1 Using cached https://files.pythonhosted.org/packages/e8/82/3b5455f74bf9ac0757d09c625b7741e6fc284d7519cffc3babb6c5173cf5/setuptools-20.1.1-py2.py3-none-any.whl Collecting docutils==0.12 Downloading https://files.pythonhosted.org/packages/c7/16/29d8de2404c5b90243b51f91315b3ce375169ceb48a68aeec0862e0143c4/docutils-0.12-py3-none-any.whl (508kB) Collecting mkdocs==0.15.0 Using cached https://files.pythonhosted.org/packages/a7/10/c839adfd209aba3a5905d4a766ea354a1d03a414d6d437e10988574de70a/mkdocs-0.15.0-py2.py3-none-any.whl Collecting PyYAML==5.2 Using cached https://files.pythonhosted.org/packages/8d/c9/e5be955a117a1ac548cdd31e37e8fd7b02ce987f9655f5c7563c656d5dcb/PyYAML-5.2.tar.gz Collecting mock==1.0.1 Using cached https://files.pythonhosted.org/packages/a2/52/7edcd94f0afb721a2d559a5b9aae8af4f8f2c79bc63fdbe8a8a6c9b23bbe/mock-1.0.1.tar.gz Collecting pillow==2.6.1 Using cached https://files.pythonhosted.org/packages/9f/53/9dafa3a48ffa25f4e22f40df880b58b99ad53648f0990caf09b1824d5db2/Pillow-2.6.1.tar.gz 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-vm68418n/readthedocs-sphinx-ext Collecting sphinx-rtd-theme==0.1.9 Downloading https://files.pythonhosted.org/packages/97/d9/e27ef5a2b6b92d2cf29724c25daf0683adacc43ab5ad15dc0e9b69b464f8/sphinx_rtd_theme-0.1.9-py3-none-any.whl (693kB) Collecting alabaster!=0.7.5,<0.8,>=0.7 Using cached https://files.pythonhosted.org/packages/10/ad/00b090d23a222943eb0eda509720a404f531a439e803f6538f35136cae9e/alabaster-0.7.12-py2.py3-none-any.whl Collecting commonmark==0.5.4 Using cached https://files.pythonhosted.org/packages/4d/93/3808cbcebe94d205f55a9a32857df733a603339d32c46cd32669d808d964/CommonMark-0.5.4.tar.gz Collecting recommonmark==0.1.1 Using cached https://files.pythonhosted.org/packages/cb/65/0c893f1be31b8892ddd491ff05a9d539459ac07b9b1c9804034589ad7eb2/recommonmark-0.1.1-py2.py3-none-any.whl Collecting six>=1.4 (from sphinx==1.3.5) Using cached https://files.pythonhosted.org/packages/ee/ff/48bde5c0f013094d729fe4b0316ba2a24774b3ff1c52d924a8a4cb04078a/six-1.15.0-py2.py3-none-any.whl Collecting snowballstemmer>=1.1 (from sphinx==1.3.5) Using cached https://files.pythonhosted.org/packages/7d/4b/cdf1113a0e88b641893b814e9c36f69a6fda28cd88b62c7f0d858cde3166/snowballstemmer-2.0.0-py2.py3-none-any.whl Collecting Jinja2>=2.3 (from sphinx==1.3.5) Downloading https://files.pythonhosted.org/packages/65/e0/eb35e762802015cab1ccee04e8a277b03f1d8e53da3ec3106882ec42558b/Jinja2-2.10.3-py2.py3-none-any.whl (125kB) Collecting babel!=2.0,>=1.3 (from sphinx==1.3.5) Using cached https://files.pythonhosted.org/packages/dd/a5/81076e10b5ef74493cf08a8e419e61b64324c9c55db4aa7f89c0240c4873/Babel-2.9.0-py2.py3-none-any.whl Collecting livereload>=2.3.2 (from mkdocs==0.15.0) Downloading https://files.pythonhosted.org/packages/bd/60/6640b819e858562ef6684abac60593b7369fe0a8a064df426d3ab0ab894d/livereload-2.6.3.tar.gz Ignoring tornado: markers 'python_version == "2.7"' don't match your environment Collecting Markdown>=2.3.1 (from mkdocs==0.15.0) Downloading https://files.pythonhosted.org/packages/7a/6b/5600647404ba15545ec37d2f7f58844d690baf2f81f3a60b862e48f29287/Markdown-3.0.1-py2.py3-none-any.whl (89kB) Collecting mkdocs-bootstrap>=0.1.1 (from mkdocs==0.15.0) Downloading https://files.pythonhosted.org/packages/e4/26/8823a7e45fad6ede3da31147514fb029dffb134e363bb0f64f7a2bd9448d/mkdocs_bootstrap-1.0.1-py2.py3-none-any.whl Collecting mkdocs-bootswatch>=0.1.0 (from mkdocs==0.15.0) Downloading https://files.pythonhosted.org/packages/42/06/1cdc2c3889c3c5803ae830bae3bf7c3fa5a0841109665d93bac81f287088/mkdocs_bootswatch-1.0-py2.py3-none-any.whl (240kB) Collecting click>=4.0 (from mkdocs==0.15.0) Downloading https://files.pythonhosted.org/packages/fa/37/45185cb5abbc30d7257104c434fe0b07e5a195a6847506c074527aa599ec/Click-7.0-py2.py3-none-any.whl (81kB) Collecting tornado>=4.1 (from mkdocs==0.15.0) Downloading https://files.pythonhosted.org/packages/e6/78/6e7b5af12c12bdf38ca9bfe863fcaf53dc10430a312d0324e76c1e5ca426/tornado-5.1.1.tar.gz (516kB) Collecting requests (from readthedocs-sphinx-ext) Downloading https://files.pythonhosted.org/packages/7d/e3/20f3d364d6c8e5d2353c72a67778eb189176f08e873c9900e10c0287b84b/requests-2.21.0-py2.py3-none-any.whl (57kB) Collecting nilsimsa>=0.3.7 (from readthedocs-sphinx-ext) Downloading https://files.pythonhosted.org/packages/e9/e4/be3c435d1f553800ccd69a5bb5b1c5b08e38a47e623d87b4c9208a6eebc7/nilsimsa-0.3.8.tar.gz (276kB) Collecting MarkupSafe>=0.23 (from Jinja2>=2.3->sphinx==1.3.5) Downloading https://files.pythonhosted.org/packages/99/c9/5d5dcf2aa90f1d4500e92467a04f63b3708ee6e5764b40b2445e767ab8dc/MarkupSafe-1.1.1-cp34-cp34m-manylinux1_x86_64.whl Collecting pytz>=2015.7 (from babel!=2.0,>=1.3->sphinx==1.3.5) Downloading https://files.pythonhosted.org/packages/12/f8/ff09af6ff61a3efaad5f61ba5facdf17e7722c4393f7d8a66674d2dbd29f/pytz-2020.4-py2.py3-none-any.whl (509kB) Collecting backports_abc>=0.4 (from tornado>=4.1->mkdocs==0.15.0) Downloading https://files.pythonhosted.org/packages/7d/56/6f3ac1b816d0cd8994e83d0c4e55bc64567532f7dc543378bd87f81cebc7/backports_abc-0.5-py2.py3-none-any.whl Collecting idna<2.9,>=2.5 (from requests->readthedocs-sphinx-ext) Downloading https://files.pythonhosted.org/packages/14/2c/cd551d81dbe15200be1cf41cd03869a46fe7226e7450af7a6545bfc474c9/idna-2.8-py2.py3-none-any.whl (58kB) Collecting urllib3<1.25,>=1.21.1 (from requests->readthedocs-sphinx-ext) Downloading https://files.pythonhosted.org/packages/01/11/525b02e4acc0c747de8b6ccdab376331597c569c42ea66ab0a1dbd36eca2/urllib3-1.24.3-py2.py3-none-any.whl (118kB) Collecting certifi>=2017.4.17 (from requests->readthedocs-sphinx-ext) Downloading https://files.pythonhosted.org/packages/c1/6f/3d85f0850962279a7e4c622695d7b3171e95ac65308a57d3b29738b27149/certifi-2020.11.8-py2.py3-none-any.whl (155kB) Collecting chardet<3.1.0,>=3.0.2 (from requests->readthedocs-sphinx-ext) Downloading https://files.pythonhosted.org/packages/bc/a9/01ffebfb562e4274b6487b4bb1ddec7ca55ec7510b22e4c51f14098443b8/chardet-3.0.4-py2.py3-none-any.whl (133kB) Building wheels for collected packages: PyYAML, mock, pillow, commonmark, livereload, tornado, nilsimsa Running setup.py bdist_wheel for PyYAML: started Running setup.py bdist_wheel for PyYAML: finished with status 'done' Stored in directory: /user_builds/pnccd-analysis-manual/.cache/pip/wheels/54/b7/c7/2ada654ee54483c9329871665aaf4a6056c3ce36f29cf66e67 Running setup.py bdist_wheel for mock: started Running setup.py bdist_wheel for mock: finished with status 'done' Stored in directory: /user_builds/pnccd-analysis-manual/.cache/pip/wheels/7e/72/92/744b532c779242b57aab4bcba80c312b30c069bbd60025e7e6 Running setup.py bdist_wheel for pillow: started Running setup.py bdist_wheel for pillow: finished with status 'done' Stored in directory: /user_builds/pnccd-analysis-manual/.cache/pip/wheels/de/0e/6b/556798d1ac8762a076ddff5b20f65b2e6cc2ae13b0e683c263 Running setup.py bdist_wheel for commonmark: started Running setup.py bdist_wheel for commonmark: finished with status 'done' Stored in directory: /user_builds/pnccd-analysis-manual/.cache/pip/wheels/a0/f4/35/019d917f6875107ade3aad634c982f5c6b604c5631cddf20ac Running setup.py bdist_wheel for livereload: started Running setup.py bdist_wheel for livereload: finished with status 'done' Stored in directory: /user_builds/pnccd-analysis-manual/.cache/pip/wheels/f2/a1/fa/00775311351a48f78b4a0e40588eefdd6f2731cc8115d6957d Running setup.py bdist_wheel for tornado: started Running setup.py bdist_wheel for tornado: finished with status 'done' Stored in directory: /user_builds/pnccd-analysis-manual/.cache/pip/wheels/6d/e1/ce/f4ee2fa420cc6b940123c64992b81047816d0a9fad6b879325 Running setup.py bdist_wheel for nilsimsa: started Running setup.py bdist_wheel for nilsimsa: finished with status 'done' Stored in directory: /user_builds/pnccd-analysis-manual/.cache/pip/wheels/64/48/61/8d7f0b227d16d55bdad76e3181b6a76eb00bbbd147305da14d Successfully built PyYAML mock pillow commonmark livereload tornado nilsimsa Installing collected packages: docutils, Pygments, alabaster, six, snowballstemmer, sphinx-rtd-theme, MarkupSafe, Jinja2, pytz, babel, sphinx, setuptools, backports-abc, tornado, livereload, Markdown, mkdocs-bootstrap, mkdocs-bootswatch, PyYAML, click, mkdocs, mock, pillow, idna, urllib3, certifi, chardet, requests, nilsimsa, readthedocs-sphinx-ext, commonmark, recommonmark Found existing installation: setuptools 28.8.0 Uninstalling setuptools-28.8.0: Successfully uninstalled setuptools-28.8.0 Running setup.py install for readthedocs-sphinx-ext: started Running setup.py install for readthedocs-sphinx-ext: finished with status 'done' Successfully installed Jinja2-2.10.3 Markdown-3.0.1 MarkupSafe-1.1.1 PyYAML-5.2 Pygments-2.1.3 alabaster-0.7.12 babel-2.9.0 backports-abc-0.5 certifi-2020.11.8 chardet-3.0.4 click-7.0 commonmark-0.5.4 docutils-0.12 idna-2.8 livereload-2.6.3 mkdocs-0.15.0 mkdocs-bootstrap-1.0.1 mkdocs-bootswatch-1.0 mock-1.0.1 nilsimsa-0.3.8 pillow-2.6.1 pytz-2020.4 readthedocs-sphinx-ext-0.5.4 recommonmark-0.1.1 requests-2.21.0 setuptools-20.1.1 six-1.15.0 snowballstemmer-2.0.0 sphinx-1.3.5 sphinx-rtd-theme-0.1.9 tornado-5.1.1 urllib3-1.24.3 You are using pip version 9.0.1, however version 20.3.1 is available. You should consider upgrading via the 'pip install --upgrade pip' command. [rtd-command-info] start-time: 2020-12-05T15:43:41.254000Z, end-time: 2020-12-05T15:44:18.361000Z, duration: 37, exit-code: 0 python /user_builds/pnccd-analysis-manual/envs/latest/bin/pip install --exists-action=w --cache-dir /user_builds/pnccd-analysis-manual/.cache/pip -rrequirements.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-_aznjazc-build Collecting sphinx==1.4.5 (from -r requirements.txt (line 4)) Downloading https://files.pythonhosted.org/packages/d1/ad/9fe56e099e0bd288f1fdc037c2146b0698e2cba1d9a48636660f39a0e791/Sphinx-1.4.5-py2.py3-none-any.whl (1.6MB) Collecting breathe==4.7.3 (from -r requirements.txt (line 5)) Downloading https://files.pythonhosted.org/packages/1c/7a/7a0f6c8367c96542d01fc1de8cedce8d93c8e3d9ded4e5b03eaefdcbcc82/breathe-4.7.3-py2.py3-none-any.whl (73kB) Collecting slumber==0.7.1 (from -r requirements.txt (line 6)) Downloading https://files.pythonhosted.org/packages/17/3a/6d42c6a5909207aa2487fda0c6f09c7dac259e5154d6ad74ec160db69660/slumber-0.7.1.tar.gz Collecting sphinxcontrib-bibtex (from -r requirements.txt (line 7)) Downloading https://files.pythonhosted.org/packages/60/de/831ec5de791ba30b842a26e27c479ed34259fb1823aa681d8028c551f4d0/sphinxcontrib_bibtex-1.0.0-py3-none-any.whl Collecting sphinxcontrib-contentui (from -r requirements.txt (line 8)) Downloading https://files.pythonhosted.org/packages/de/9d/12d92cd1b37c9da35a53b56802025f6aa7826934c7cf0df6e4cfe0b90f8e/sphinxcontrib_contentui-0.2.5-py3-none-any.whl Requirement already satisfied: alabaster<0.8,>=0.7 in /user_builds/pnccd-analysis-manual/envs/latest/lib/python3.4/site-packages (from sphinx==1.4.5->-r requirements.txt (line 4)) Requirement already satisfied: snowballstemmer>=1.1 in /user_builds/pnccd-analysis-manual/envs/latest/lib/python3.4/site-packages (from sphinx==1.4.5->-r requirements.txt (line 4)) Requirement already satisfied: docutils>=0.11 in /user_builds/pnccd-analysis-manual/envs/latest/lib/python3.4/site-packages (from sphinx==1.4.5->-r requirements.txt (line 4)) Collecting imagesize (from sphinx==1.4.5->-r requirements.txt (line 4)) Downloading https://files.pythonhosted.org/packages/31/b2/b5522a0c8d11e4aff83f8342f3f0dea68c2fb25aa44403e420587f0ce204/imagesize-1.2.0-py2.py3-none-any.whl Requirement already satisfied: Jinja2>=2.3 in /user_builds/pnccd-analysis-manual/envs/latest/lib/python3.4/site-packages (from sphinx==1.4.5->-r requirements.txt (line 4)) Requirement already satisfied: babel!=2.0,>=1.3 in /user_builds/pnccd-analysis-manual/envs/latest/lib/python3.4/site-packages (from sphinx==1.4.5->-r requirements.txt (line 4)) Requirement already satisfied: six>=1.4 in /user_builds/pnccd-analysis-manual/envs/latest/lib/python3.4/site-packages (from sphinx==1.4.5->-r requirements.txt (line 4)) Requirement already satisfied: Pygments>=2.0 in /user_builds/pnccd-analysis-manual/envs/latest/lib/python3.4/site-packages (from sphinx==1.4.5->-r requirements.txt (line 4)) Requirement already satisfied: requests in /user_builds/pnccd-analysis-manual/envs/latest/lib/python3.4/site-packages (from slumber==0.7.1->-r requirements.txt (line 6)) Collecting pybtex-docutils>=0.2.0 (from sphinxcontrib-bibtex->-r requirements.txt (line 7)) Downloading https://files.pythonhosted.org/packages/e9/97/066aa09efc1a1f969ffc6ca0e697787a3b8eb9e847a9b5973c0f73119318/pybtex_docutils-0.2.2-py2.py3-none-any.whl Collecting pybtex>=0.20 (from sphinxcontrib-bibtex->-r requirements.txt (line 7)) Downloading https://files.pythonhosted.org/packages/15/ef/9f93c1084aef4dcd190c86a9e405e97b065a96514c74ce34b2fd5c02fe73/pybtex-0.23.0-py2.py3-none-any.whl (279kB) Collecting oset>=0.1.3 (from sphinxcontrib-bibtex->-r requirements.txt (line 7)) Downloading https://files.pythonhosted.org/packages/d6/b1/a49498c699a3fda5d635cc1fa222ffc686ea3b5d04b84a3166c4cab0c57b/oset-0.1.3.tar.gz Requirement already satisfied: MarkupSafe>=0.23 in /user_builds/pnccd-analysis-manual/envs/latest/lib/python3.4/site-packages (from Jinja2>=2.3->sphinx==1.4.5->-r requirements.txt (line 4)) Requirement already satisfied: pytz>=2015.7 in /user_builds/pnccd-analysis-manual/envs/latest/lib/python3.4/site-packages (from babel!=2.0,>=1.3->sphinx==1.4.5->-r requirements.txt (line 4)) Requirement already satisfied: chardet<3.1.0,>=3.0.2 in /user_builds/pnccd-analysis-manual/envs/latest/lib/python3.4/site-packages (from requests->slumber==0.7.1->-r requirements.txt (line 6)) Requirement already satisfied: idna<2.9,>=2.5 in /user_builds/pnccd-analysis-manual/envs/latest/lib/python3.4/site-packages (from requests->slumber==0.7.1->-r requirements.txt (line 6)) Requirement already satisfied: urllib3<1.25,>=1.21.1 in /user_builds/pnccd-analysis-manual/envs/latest/lib/python3.4/site-packages (from requests->slumber==0.7.1->-r requirements.txt (line 6)) Requirement already satisfied: certifi>=2017.4.17 in /user_builds/pnccd-analysis-manual/envs/latest/lib/python3.4/site-packages (from requests->slumber==0.7.1->-r requirements.txt (line 6)) Collecting latexcodec>=1.0.4 (from pybtex>=0.20->sphinxcontrib-bibtex->-r requirements.txt (line 7)) Downloading https://files.pythonhosted.org/packages/0a/76/9552dfc6b74c2d6c3f199e927d41998dc1e561b7cbe4af7e7247388e17e8/latexcodec-2.0.1-py2.py3-none-any.whl Requirement already satisfied: PyYAML>=3.01 in /user_builds/pnccd-analysis-manual/envs/latest/lib/python3.4/site-packages (from pybtex>=0.20->sphinxcontrib-bibtex->-r requirements.txt (line 7)) Requirement already satisfied: setuptools in /user_builds/pnccd-analysis-manual/envs/latest/lib/python3.4/site-packages (from oset>=0.1.3->sphinxcontrib-bibtex->-r requirements.txt (line 7)) Building wheels for collected packages: slumber, oset Running setup.py bdist_wheel for slumber: started Running setup.py bdist_wheel for slumber: finished with status 'done' Stored in directory: /user_builds/pnccd-analysis-manual/.cache/pip/wheels/48/ae/95/28defa1956124d566c55e105d5e8ecacc63c4ad0b6e15d08bd Running setup.py bdist_wheel for oset: started Running setup.py bdist_wheel for oset: finished with status 'done' Stored in directory: /user_builds/pnccd-analysis-manual/.cache/pip/wheels/4e/87/c8/3dad2dca279f64fb68af5d9908c380fee2f16488a1b1da3499 Successfully built slumber oset Installing collected packages: imagesize, sphinx, breathe, slumber, latexcodec, pybtex, pybtex-docutils, oset, sphinxcontrib-bibtex, sphinxcontrib-contentui, RTDConf Found existing installation: Sphinx 1.3.5 Uninstalling Sphinx-1.3.5: Successfully uninstalled Sphinx-1.3.5 Running setup.py install for RTDConf: started Running setup.py install for RTDConf: finished with status 'done' Successfully installed RTDConf-0.1 breathe-4.7.3 imagesize-1.2.0 latexcodec-2.0.1 oset-0.1.3 pybtex-0.23.0 pybtex-docutils-0.2.2 slumber-0.7.1 sphinx-1.4.5 sphinxcontrib-bibtex-1.0.0 sphinxcontrib-contentui-0.2.5 You are using pip version 9.0.1, however version 20.3.1 is available. You should consider upgrading via the 'pip install --upgrade pip' command. [rtd-command-info] start-time: 2020-12-05T15:44:18.924000Z, end-time: 2020-12-05T15:44:18.942000Z, duration: 0, exit-code: 0 cat conf.py #!/usr/bin/env python3 # -*- 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 # sys.path.insert(0, os.path.abspath('.')) # -- General configuration ------------------------------------------------ # If your documentation needs a minimal Sphinx version, state it here. # # needs_sphinx = '1.0' # Add any Sphinx extension module names here, as strings. They can be # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom # ones. extensions = [ 'sphinx.ext.autodoc', 'sphinx.ext.intersphinx', 'sphinx.ext.todo', 'sphinx.ext.mathjax', 'sphinx.ext.ifconfig', 'sphinx.ext.viewcode', 'sphinx.ext.graphviz', 'sphinxcontrib.bibtex', 'sphinxcontrib.contentui' ] # 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 = 'pnCCD_Performance' copyright = '2020, XFEL Detector Operation Group' #author = 'XFEL Detector Group' author = u'Kiana Setoodehnia' # 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 = '2.0' # The full version, including alpha/beta/rc tags. release = ': Version 2.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 = 'alabaster' # 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 = 'Performance Evaluation of the New 1 Mpix pnCCD at SQS' # A shorter title for the navigation bar. Default is the same as html_title. # html_short_title = "pnCCD Performance 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'] # 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 = 'pnCCDdoc' # -- 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_Performance.tex', 'Performance Evaluation of the New 1 Mpix pnCCD at SQS', 'Kiana Setoodehnia', '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, 'pnccd', 'Performance Evaluation of the New 1 Mpix pnCCD at SQS', [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, 'pnCCD_Performance', 'Performance Evaluation of the New 1 Mpix pnCCD at SQS', author, 'pnCCD_Performance', 'This is the pnCCD performance 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://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), '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 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/"), ], 'downloads': [ ], 'subprojects': [ ], 'slug': 'pnccd-analysis-manual', 'name': u'pnCCD Analysis Manual', 'rtd_language': u'en', 'canonical_url': 'http://exflrtd.desy.de/docs/pnccd-analysis-manual/en/latest/', 'analytics_code': '', 'single_version': False, 'conf_py_path': '/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': 'f3103ba8', } 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: 2020-12-05T15:44:19.155000Z, end-time: 2020-12-05T15:44:27.029000Z, duration: 7, exit-code: 1 python /user_builds/pnccd-analysis-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... Traceback (most recent call last): File "/user_builds/pnccd-analysis-manual/envs/latest/lib/python3.4/site-packages/sphinx/cmdline.py", line 243, in main opts.warningiserror, opts.tags, opts.verbosity, opts.jobs) File "/user_builds/pnccd-analysis-manual/envs/latest/lib/python3.4/site-packages/sphinx/application.py", line 163, in __init__ self.setup_extension(extension) File "/user_builds/pnccd-analysis-manual/envs/latest/lib/python3.4/site-packages/sphinx/application.py", line 473, in setup_extension mod = __import__(extension, None, None, ['setup']) File "/user_builds/pnccd-analysis-manual/envs/latest/lib/python3.4/site-packages/sphinxcontrib/bibtex/__init__.py", line 19, in from sphinxcontrib.bibtex.roles import CiteRole File "/user_builds/pnccd-analysis-manual/envs/latest/lib/python3.4/site-packages/sphinxcontrib/bibtex/roles.py", line 12, in import pybtex.database File "/user_builds/pnccd-analysis-manual/envs/latest/lib/python3.4/site-packages/pybtex/database/__init__.py", line 124 f" entries={repr_entry},\n\n" ^ SyntaxError: invalid syntax Exception occurred: File "/user_builds/pnccd-analysis-manual/envs/latest/lib/python3.4/site-packages/sphinxcontrib/bibtex/roles.py", line 12, in import pybtex.database File "/user_builds/pnccd-analysis-manual/envs/latest/lib/python3.4/site-packages/pybtex/database/__init__.py", line 124 f" entries={repr_entry},\n\n" ^ SyntaxError: invalid syntax The full traceback has been saved in /tmp/sphinx-err-zdwv6_eh.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!